storage

package
v12.4.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Feb 3, 2018 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

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

The Azure Storage Management API.

Deprecated: Please instead use github.com/Azure/azure-sdk-for-go/services/storage/mgmt/2017-06-01/storage

Index

Constants

View Source 
const (
	// 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"`
	Identity           *Identity           `json:"identity,omitempty"`
	*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 the parameters used to check the availabity of the storage account name.

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"`
	Identity                           *Identity           `json:"identity,omitempty"`
	*AccountPropertiesCreateParameters `json:"properties,omitempty"`
}

AccountCreateParameters is the parameters used when creating a storage 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 response from the ListKeys operation.

type AccountListResult 

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

AccountListResult is the response from the List Storage Accounts operation.

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"`
	EnableHTTPSTrafficOnly *bool             `json:"supportsHttpsTrafficOnly,omitempty"`
	NetworkRuleSet         *NetworkRuleSet   `json:"networkAcls,omitempty"`
}

AccountProperties is properties of the storage account.

type AccountPropertiesCreateParameters 

type AccountPropertiesCreateParameters struct {
	CustomDomain           *CustomDomain   `json:"customDomain,omitempty"`
	Encryption             *Encryption     `json:"encryption,omitempty"`
	NetworkRuleSet         *NetworkRuleSet `json:"networkAcls,omitempty"`
	AccessTier             AccessTier      `json:"accessTier,omitempty"`
	EnableHTTPSTrafficOnly *bool           `json:"supportsHttpsTrafficOnly,omitempty"`
}

AccountPropertiesCreateParameters is the parameters used to create the storage account.

type AccountPropertiesUpdateParameters 

type AccountPropertiesUpdateParameters struct {
	CustomDomain           *CustomDomain   `json:"customDomain,omitempty"`
	Encryption             *Encryption     `json:"encryption,omitempty"`
	AccessTier             AccessTier      `json:"accessTier,omitempty"`
	EnableHTTPSTrafficOnly *bool           `json:"supportsHttpsTrafficOnly,omitempty"`
	NetworkRuleSet         *NetworkRuleSet `json:"networkAcls,omitempty"`
}

AccountPropertiesUpdateParameters is the parameters used when updating a storage account.

type AccountRegenerateKeyParameters 

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

AccountRegenerateKeyParameters is the parameters used to regenerate the storage account key.

type AccountSasParameters 

type AccountSasParameters struct {
	Services               Services            `json:"signedServices,omitempty"`
	ResourceTypes          SignedResourceTypes `json:"signedResourceTypes,omitempty"`
	Permissions            Permissions         `json:"signedPermission,omitempty"`
	IPAddressOrRange       *string             `json:"signedIp,omitempty"`
	Protocols              HTTPProtocol        `json:"signedProtocol,omitempty"`
	SharedAccessStartTime  *date.Time          `json:"signedStart,omitempty"`
	SharedAccessExpiryTime *date.Time          `json:"signedExpiry,omitempty"`
	KeyToSign              *string             `json:"keyToSign,omitempty"`
}

AccountSasParameters is the parameters to list SAS credentials of a storage account.

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"`
	Identity                           *Identity           `json:"identity,omitempty"`
	*AccountPropertiesUpdateParameters `json:"properties,omitempty"`
}

AccountUpdateParameters is the parameters that can be provided when updating the storage account properties.

type AccountsClient 

type AccountsClient struct {
	ManagementClient
}

AccountsClient is the the Azure Storage Management API.

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 the storage account name is valid and is not already 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{}) (<-chan Account, <-chan 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. 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. The name is case insensitive. 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 Account, 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. The name is case insensitive. 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, SKU name, 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. The name is case insensitive. 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) ListAccountSAS 

func (client AccountsClient) ListAccountSAS(resourceGroupName string, accountName string, parameters AccountSasParameters) (result ListAccountSasResponse, err error)

ListAccountSAS list SAS credentials of a storage account.

resourceGroupName is the name of the resource group within the user's subscription. The name is case insensitive. 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 to list SAS credentials for the storage account.

func (AccountsClient) ListAccountSASPreparer 

func (client AccountsClient) ListAccountSASPreparer(resourceGroupName string, accountName string, parameters AccountSasParameters) (*http.Request, error)

ListAccountSASPreparer prepares the ListAccountSAS request.

func (AccountsClient) ListAccountSASResponder 

func (client AccountsClient) ListAccountSASResponder(resp *http.Response) (result ListAccountSasResponse, err error)

ListAccountSASResponder handles the response to the ListAccountSAS request. The method always closes the http.Response Body.

func (AccountsClient) ListAccountSASSender 

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

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

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. The name is case insensitive.

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 within the user's subscription. The name is case insensitive. 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) 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) ListServiceSAS 

func (client AccountsClient) ListServiceSAS(resourceGroupName string, accountName string, parameters ServiceSasParameters) (result ListServiceSasResponse, err error)

ListServiceSAS list service SAS credentials of a specific resource.

resourceGroupName is the name of the resource group within the user's subscription. The name is case insensitive. 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 to list service SAS credentials.

func (AccountsClient) ListServiceSASPreparer 

func (client AccountsClient) ListServiceSASPreparer(resourceGroupName string, accountName string, parameters ServiceSasParameters) (*http.Request, error)

ListServiceSASPreparer prepares the ListServiceSAS request.

func (AccountsClient) ListServiceSASResponder 

func (client AccountsClient) ListServiceSASResponder(resp *http.Response) (result ListServiceSasResponse, err error)

ListServiceSASResponder handles the response to the ListServiceSAS request. The method always closes the http.Response Body.

func (AccountsClient) ListServiceSASSender 

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

ListServiceSASSender sends the ListServiceSAS 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 one of the access keys for the specified storage account.

resourceGroupName is the name of the resource group within the user's subscription. The name is case insensitive. 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.

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 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.

resourceGroupName is the name of the resource group within the user's subscription. The name is case insensitive. 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 Action 

type Action string

Action enumerates the values for action. 

const (
	// Allow specifies the allow state for action.
	Allow Action = "Allow"
)

type Bypass 

type Bypass string

Bypass enumerates the values for bypass. 

const (
	// AzureServices specifies the azure services state for bypass.
	AzureServices Bypass = "AzureServices"
	// Logging specifies the logging state for bypass.
	Logging Bypass = "Logging"
	// Metrics specifies the metrics state for bypass.
	Metrics Bypass = "Metrics"
	// None specifies the none state for bypass.
	None Bypass = "None"
)

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 DefaultAction 

type DefaultAction string

DefaultAction enumerates the values for default action. 

const (
	// DefaultActionAllow specifies the default action allow state for default action.
	DefaultActionAllow DefaultAction = "Allow"
	// DefaultActionDeny specifies the default action deny state for default action.
	DefaultActionDeny DefaultAction = "Deny"
)

type Dimension 

type Dimension struct {
	Name        *string `json:"name,omitempty"`
	DisplayName *string `json:"displayName,omitempty"`
}

Dimension is dimension of blobs, possiblly be blob type or access tier.

type Encryption 

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

Encryption is the encryption settings on the storage account.

type EncryptionService 

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

EncryptionService is a service that allows server-side encryption to be used.

type EncryptionServices 

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

EncryptionServices is a list of services that support encryption.

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 HTTPProtocol 

type HTTPProtocol string

HTTPProtocol enumerates the values for http protocol. 

const (
	// HTTPS specifies the https state for http protocol.
	HTTPS HTTPProtocol = "https"
	// Httpshttp specifies the httpshttp state for http protocol.
	Httpshttp HTTPProtocol = "https,http"
)

type IPRule 

type IPRule struct {
	IPAddressOrRange *string `json:"value,omitempty"`
	Action           Action  `json:"action,omitempty"`
}

IPRule is IP rule with specific IP or IP range in CIDR format.

type Identity 

type Identity struct {
	PrincipalID *string `json:"principalId,omitempty"`
	TenantID    *string `json:"tenantId,omitempty"`
	Type        *string `json:"type,omitempty"`
}

Identity is identity for the resource.

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 KeySource 

type KeySource string

KeySource enumerates the values for key source. 

const (
	// MicrosoftKeyvault specifies the microsoft keyvault state for key source.
	MicrosoftKeyvault KeySource = "Microsoft.Keyvault"
	// MicrosoftStorage specifies the microsoft storage state for key source.
	MicrosoftStorage KeySource = "Microsoft.Storage"
)

type KeyVaultProperties 

type KeyVaultProperties struct {
	KeyName     *string `json:"keyname,omitempty"`
	KeyVersion  *string `json:"keyversion,omitempty"`
	KeyVaultURI *string `json:"keyvaulturi,omitempty"`
}

KeyVaultProperties is properties of key vault.

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 ListAccountSasResponse 

type ListAccountSasResponse struct {
	autorest.Response `json:"-"`
	AccountSasToken   *string `json:"accountSasToken,omitempty"`
}

ListAccountSasResponse is the List SAS credentials operation response.

type ListServiceSasResponse 

type ListServiceSasResponse struct {
	autorest.Response `json:"-"`
	ServiceSasToken   *string `json:"serviceSasToken,omitempty"`
}

ListServiceSasResponse is the List service SAS credentials operation response.

type ManagementClient 

type ManagementClient struct {
	autorest.Client
	BaseURI        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 MetricSpecification 

type MetricSpecification struct {
	Name                            *string      `json:"name,omitempty"`
	DisplayName                     *string      `json:"displayName,omitempty"`
	DisplayDescription              *string      `json:"displayDescription,omitempty"`
	Unit                            *string      `json:"unit,omitempty"`
	Dimensions                      *[]Dimension `json:"dimensions,omitempty"`
	AggregationType                 *string      `json:"aggregationType,omitempty"`
	FillGapWithZero                 *bool        `json:"fillGapWithZero,omitempty"`
	Category                        *string      `json:"category,omitempty"`
	ResourceIDDimensionNameOverride *string      `json:"resourceIdDimensionNameOverride,omitempty"`
}

MetricSpecification is metric specification of operation.

type NetworkRuleSet 

type NetworkRuleSet struct {
	Bypass              Bypass                `json:"bypass,omitempty"`
	VirtualNetworkRules *[]VirtualNetworkRule `json:"virtualNetworkRules,omitempty"`
	IPRules             *[]IPRule             `json:"ipRules,omitempty"`
	DefaultAction       DefaultAction         `json:"defaultAction,omitempty"`
}

NetworkRuleSet is network rule set

type Operation 

type Operation struct {
	Name                 *string           `json:"name,omitempty"`
	Display              *OperationDisplay `json:"display,omitempty"`
	Origin               *string           `json:"origin,omitempty"`
	*OperationProperties `json:"properties,omitempty"`
}

Operation is storage REST API operation definition.

type OperationDisplay 

type OperationDisplay struct {
	Provider  *string `json:"provider,omitempty"`
	Resource  *string `json:"resource,omitempty"`
	Operation *string `json:"operation,omitempty"`
}

OperationDisplay is display metadata associated with the operation.

type OperationListResult 

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

OperationListResult is result of the request to list Storage operations. It contains a list of operations and a URL link to get the next set of results.

type OperationProperties 

type OperationProperties struct {
	ServiceSpecification *ServiceSpecification `json:"serviceSpecification,omitempty"`
}

OperationProperties is properties of operation, include metric specifications.

type OperationsClient 

type OperationsClient struct {
	ManagementClient
}

OperationsClient is the the Azure Storage Management API.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List 

func (client OperationsClient) List() (result OperationListResult, err error)

List lists all of the available Storage Rest API operations.

func (OperationsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

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

func (OperationsClient) ListSender 

func (client OperationsClient) 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 Permissions 

type Permissions string

Permissions enumerates the values for permissions. 

const (
	// A specifies the a state for permissions.
	A Permissions = "a"
	// C specifies the c state for permissions.
	C Permissions = "c"
	// D specifies the d state for permissions.
	D Permissions = "d"
	// L specifies the l state for permissions.
	L Permissions = "l"
	// P specifies the p state for permissions.
	P Permissions = "p"
	// R specifies the r state for permissions.
	R Permissions = "r"
	// U specifies the u state for permissions.
	U Permissions = "u"
	// W specifies the w state for permissions.
	W Permissions = "w"
)

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 ReasonCode 

type ReasonCode string

ReasonCode enumerates the values for reason code. 

const (
	// NotAvailableForSubscription specifies the not available for subscription state for reason code.
	NotAvailableForSubscription ReasonCode = "NotAvailableForSubscription"
	// QuotaID specifies the quota id state for reason code.
	QuotaID ReasonCode = "QuotaId"
)

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 describes a storage resource.

type Restriction 

type Restriction struct {
	Type       *string    `json:"type,omitempty"`
	Values     *[]string  `json:"values,omitempty"`
	ReasonCode ReasonCode `json:"reasonCode,omitempty"`
}

Restriction is the restriction because of which SKU cannot be used.

type SKUCapability 

type SKUCapability struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

SKUCapability is the capability information in the specified sku, including file encryption, network acls, change notification, etc.

type ServiceSasParameters 

type ServiceSasParameters struct {
	CanonicalizedResource  *string        `json:"canonicalizedResource,omitempty"`
	Resource               SignedResource `json:"signedResource,omitempty"`
	Permissions            Permissions    `json:"signedPermission,omitempty"`
	IPAddressOrRange       *string        `json:"signedIp,omitempty"`
	Protocols              HTTPProtocol   `json:"signedProtocol,omitempty"`
	SharedAccessStartTime  *date.Time     `json:"signedStart,omitempty"`
	SharedAccessExpiryTime *date.Time     `json:"signedExpiry,omitempty"`
	Identifier             *string        `json:"signedIdentifier,omitempty"`
	PartitionKeyStart      *string        `json:"startPk,omitempty"`
	PartitionKeyEnd        *string        `json:"endPk,omitempty"`
	RowKeyStart            *string        `json:"startRk,omitempty"`
	RowKeyEnd              *string        `json:"endRk,omitempty"`
	KeyToSign              *string        `json:"keyToSign,omitempty"`
	CacheControl           *string        `json:"rscc,omitempty"`
	ContentDisposition     *string        `json:"rscd,omitempty"`
	ContentEncoding        *string        `json:"rsce,omitempty"`
	ContentLanguage        *string        `json:"rscl,omitempty"`
	ContentType            *string        `json:"rsct,omitempty"`
}

ServiceSasParameters is the parameters to list service SAS credentials of a speicific resource.

type ServiceSpecification 

type ServiceSpecification struct {
	MetricSpecifications *[]MetricSpecification `json:"metricSpecifications,omitempty"`
}

ServiceSpecification is one property of operation, include metric specifications.

type Services 

type Services string

Services enumerates the values for services. 

const (
	// B specifies the b state for services.
	B Services = "b"
	// F specifies the f state for services.
	F Services = "f"
	// Q specifies the q state for services.
	Q Services = "q"
	// T specifies the t state for services.
	T Services = "t"
)

type SignedResource 

type SignedResource string

SignedResource enumerates the values for signed resource. 

const (
	// SignedResourceB specifies the signed resource b state for signed resource.
	SignedResourceB SignedResource = "b"
	// SignedResourceC specifies the signed resource c state for signed resource.
	SignedResourceC SignedResource = "c"
	// SignedResourceF specifies the signed resource f state for signed resource.
	SignedResourceF SignedResource = "f"
	// SignedResourceS specifies the signed resource s state for signed resource.
	SignedResourceS SignedResource = "s"
)

type SignedResourceTypes 

type SignedResourceTypes string

SignedResourceTypes enumerates the values for signed resource types. 

const (
	// SignedResourceTypesC specifies the signed resource types c state for signed resource types.
	SignedResourceTypesC SignedResourceTypes = "c"
	// SignedResourceTypesO specifies the signed resource types o state for signed resource types.
	SignedResourceTypesO SignedResourceTypes = "o"
	// SignedResourceTypesS specifies the signed resource types s state for signed resource types.
	SignedResourceTypesS SignedResourceTypes = "s"
)

type Sku 

type Sku struct {
	Name         SkuName          `json:"name,omitempty"`
	Tier         SkuTier          `json:"tier,omitempty"`
	ResourceType *string          `json:"resourceType,omitempty"`
	Kind         Kind             `json:"kind,omitempty"`
	Locations    *[]string        `json:"locations,omitempty"`
	Capabilities *[]SKUCapability `json:"capabilities,omitempty"`
	Restrictions *[]Restriction   `json:"restrictions,omitempty"`
}

Sku is the SKU of the storage account.

type SkuListResult 

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

SkuListResult is the response from the List Storage SKUs operation.

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 SkusClient 

type SkusClient struct {
	ManagementClient
}

SkusClient is the the Azure Storage Management API.

func NewSkusClient 

func NewSkusClient(subscriptionID string) SkusClient

NewSkusClient creates an instance of the SkusClient client.

func NewSkusClientWithBaseURI 

func NewSkusClientWithBaseURI(baseURI string, subscriptionID string) SkusClient

NewSkusClientWithBaseURI creates an instance of the SkusClient client.

func (SkusClient) List 

func (client SkusClient) List() (result SkuListResult, err error)

List lists the available SKUs supported by Microsoft.Storage for given subscription.

func (SkusClient) ListPreparer 

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

ListPreparer prepares the List request.

func (SkusClient) ListResponder 

func (client SkusClient) ListResponder(resp *http.Response) (result SkuListResult, err error)

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

func (SkusClient) ListSender 

func (client SkusClient) 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 State 

type State string

State enumerates the values for state. 

const (
	// StateDeprovisioning specifies the state deprovisioning state for state.
	StateDeprovisioning State = "deprovisioning"
	// StateFailed specifies the state failed state for state.
	StateFailed State = "failed"
	// StateNetworkSourceDeleted specifies the state network source deleted state for state.
	StateNetworkSourceDeleted State = "networkSourceDeleted"
	// StateProvisioning specifies the state provisioning state for state.
	StateProvisioning State = "provisioning"
	// StateSucceeded specifies the state succeeded state for state.
	StateSucceeded State = "succeeded"
)

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 UsageClient 

type UsageClient struct {
	ManagementClient
}

UsageClient is the the Azure Storage Management API.

func NewUsageClient 

func NewUsageClient(subscriptionID string) UsageClient

NewUsageClient creates an instance of the UsageClient client.

func NewUsageClientWithBaseURI 

func NewUsageClientWithBaseURI(baseURI string, subscriptionID string) UsageClient

NewUsageClientWithBaseURI creates an instance of the UsageClient client.

func (UsageClient) List 

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

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

func (UsageClient) ListPreparer 

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

ListPreparer prepares the List request.

func (UsageClient) ListResponder 

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 

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 

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

UsageListResult is the response from the List Usages operation.

type UsageName 

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

UsageName is the usage names that can be used; currently limited to StorageAccount.

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"
)

type VirtualNetworkRule 

type VirtualNetworkRule struct {
	VirtualNetworkResourceID *string `json:"id,omitempty"`
	Action                   Action  `json:"action,omitempty"`
	State                    State   `json:"state,omitempty"`
}

VirtualNetworkRule is virtual Network rule.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.