storage

package
v68.0.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Jan 19, 2023 License: MIT Imports: 10 Imported by: 249

Documentation

Overview

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

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

The Azure Storage Management API.

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 ...
	Cool AccessTier = "Cool"
	// Hot ...
	Hot AccessTier = "Hot"
)

func PossibleAccessTierValues

func PossibleAccessTierValues() []AccessTier

PossibleAccessTierValues returns an array of possible values for the AccessTier const type.

type Account

type Account struct {
	autorest.Response `json:"-"`
	// Sku - READ-ONLY; Gets the SKU.
	Sku *Sku `json:"sku,omitempty"`
	// Kind - READ-ONLY; Gets the Kind. Possible values include: 'Storage', 'StorageV2', 'BlobStorage', 'FileStorage', 'BlockBlobStorage'
	Kind Kind `json:"kind,omitempty"`
	// Identity - The identity of the resource.
	Identity *Identity `json:"identity,omitempty"`
	// AccountProperties - Properties of the storage account.
	*AccountProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Account the storage account.

func (Account) MarshalJSON

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

MarshalJSON is the custom marshaler for Account.

func (*Account) UnmarshalJSON

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

UnmarshalJSON is the custom unmarshaler for Account struct.

type AccountCheckNameAvailabilityParameters

type AccountCheckNameAvailabilityParameters struct {
	// Name - The storage account name.
	Name *string `json:"name,omitempty"`
	// Type - The type of resource, Microsoft.Storage/storageAccounts
	Type *string `json:"type,omitempty"`
}

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

type AccountCreateParameters

type AccountCreateParameters struct {
	// Sku - Required. Gets or sets the SKU name.
	Sku *Sku `json:"sku,omitempty"`
	// Kind - Required. Indicates the type of storage account. Possible values include: 'Storage', 'StorageV2', 'BlobStorage', 'FileStorage', 'BlockBlobStorage'
	Kind Kind `json:"kind,omitempty"`
	// Location - Required. Gets or sets 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 - Gets or sets 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"`
	// Identity - The identity of the resource.
	Identity *Identity `json:"identity,omitempty"`
	// AccountPropertiesCreateParameters - The parameters used to create the storage account.
	*AccountPropertiesCreateParameters `json:"properties,omitempty"`
}

AccountCreateParameters the parameters used when creating a storage account.

func (AccountCreateParameters) MarshalJSON

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

MarshalJSON is the custom marshaler for AccountCreateParameters.

func (*AccountCreateParameters) UnmarshalJSON

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

UnmarshalJSON is the custom unmarshaler for AccountCreateParameters struct.

type AccountExpand

type AccountExpand string

AccountExpand enumerates the values for account expand.

const (
	// AccountExpandGeoReplicationStats ...
	AccountExpandGeoReplicationStats AccountExpand = "geoReplicationStats"
)

func PossibleAccountExpandValues

func PossibleAccountExpandValues() []AccountExpand

PossibleAccountExpandValues returns an array of possible values for the AccountExpand const type.

type AccountKey

type AccountKey struct {
	// KeyName - READ-ONLY; Name of the key.
	KeyName *string `json:"keyName,omitempty"`
	// Value - READ-ONLY; Base 64-encoded value of the key.
	Value *string `json:"value,omitempty"`
	// Permissions - READ-ONLY; Permissions for the key -- read-only or full permissions. Possible values include: 'Read', 'Full'
	Permissions KeyPermission `json:"permissions,omitempty"`
}

AccountKey an access key for the storage account.

func (AccountKey) MarshalJSON

func (ak AccountKey) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountKey.

type AccountListKeysResult

type AccountListKeysResult struct {
	autorest.Response `json:"-"`
	// Keys - READ-ONLY; Gets the list of storage account keys and their properties for the specified storage account.
	Keys *[]AccountKey `json:"keys,omitempty"`
}

AccountListKeysResult the response from the ListKeys operation.

func (AccountListKeysResult) MarshalJSON

func (alkr AccountListKeysResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountListKeysResult.

type AccountListResult

type AccountListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; Gets the list of storage accounts and their properties.
	Value *[]Account `json:"value,omitempty"`
	// NextLink - READ-ONLY; Request URL that can be used to query next page of storage accounts. Returned when total number of requested storage accounts exceed maximum page size.
	NextLink *string `json:"nextLink,omitempty"`
}

AccountListResult the response from the List Storage Accounts operation.

func (AccountListResult) IsEmpty

func (alr AccountListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (AccountListResult) MarshalJSON

func (alr AccountListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountListResult.

type AccountListResultIterator

type AccountListResultIterator struct {
	// contains filtered or unexported fields
}

AccountListResultIterator provides access to a complete listing of Account values.

func NewAccountListResultIterator

func NewAccountListResultIterator(page AccountListResultPage) AccountListResultIterator

Creates a new instance of the AccountListResultIterator type.

func (*AccountListResultIterator) Next

func (iter *AccountListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AccountListResultIterator) NextWithContext

func (iter *AccountListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (AccountListResultIterator) NotDone

func (iter AccountListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (AccountListResultIterator) Response

Response returns the raw server response from the last page request.

func (AccountListResultIterator) Value

func (iter AccountListResultIterator) Value() Account

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type AccountListResultPage

type AccountListResultPage struct {
	// contains filtered or unexported fields
}

AccountListResultPage contains a page of Account values.

func NewAccountListResultPage

func NewAccountListResultPage(cur AccountListResult, getNextPage func(context.Context, AccountListResult) (AccountListResult, error)) AccountListResultPage

Creates a new instance of the AccountListResultPage type.

func (*AccountListResultPage) Next

func (page *AccountListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AccountListResultPage) NextWithContext

func (page *AccountListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (AccountListResultPage) NotDone

func (page AccountListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (AccountListResultPage) Response

func (page AccountListResultPage) Response() AccountListResult

Response returns the raw server response from the last page request.

func (AccountListResultPage) Values

func (page AccountListResultPage) Values() []Account

Values returns the slice of values for the current page or nil if there are no values.

type AccountProperties

type AccountProperties struct {
	// ProvisioningState - READ-ONLY; Gets the status of the storage account at the time the operation was called. Possible values include: 'Creating', 'ResolvingDNS', 'Succeeded'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// PrimaryEndpoints - READ-ONLY; Gets 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 - READ-ONLY; Gets the location of the primary data center for the storage account.
	PrimaryLocation *string `json:"primaryLocation,omitempty"`
	// StatusOfPrimary - READ-ONLY; Gets 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 - READ-ONLY; Gets 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 - READ-ONLY; Gets 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 - READ-ONLY; Gets 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 - READ-ONLY; Gets the creation date and time of the storage account in UTC.
	CreationTime *date.Time `json:"creationTime,omitempty"`
	// CustomDomain - READ-ONLY; Gets the custom domain the user assigned to this storage account.
	CustomDomain *CustomDomain `json:"customDomain,omitempty"`
	// SecondaryEndpoints - READ-ONLY; Gets 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"`
	// Encryption - READ-ONLY; Gets the encryption settings on the account. If unspecified, the account is unencrypted.
	Encryption *Encryption `json:"encryption,omitempty"`
	// AccessTier - READ-ONLY; Required for storage accounts where kind = BlobStorage. The access tier used for billing. Possible values include: 'Hot', 'Cool'
	AccessTier AccessTier `json:"accessTier,omitempty"`
	// AzureFilesIdentityBasedAuthentication - Provides the identity based authentication settings for Azure Files.
	AzureFilesIdentityBasedAuthentication *AzureFilesIdentityBasedAuthentication `json:"azureFilesIdentityBasedAuthentication,omitempty"`
	// EnableHTTPSTrafficOnly - Allows https traffic only to storage service if sets to true.
	EnableHTTPSTrafficOnly *bool `json:"supportsHttpsTrafficOnly,omitempty"`
	// NetworkRuleSet - READ-ONLY; Network rule set
	NetworkRuleSet *NetworkRuleSet `json:"networkAcls,omitempty"`
	// IsHnsEnabled - Account HierarchicalNamespace enabled if sets to true.
	IsHnsEnabled *bool `json:"isHnsEnabled,omitempty"`
	// GeoReplicationStats - READ-ONLY; Geo Replication Stats
	GeoReplicationStats *GeoReplicationStats `json:"geoReplicationStats,omitempty"`
	// FailoverInProgress - READ-ONLY; If the failover is in progress, the value will be true, otherwise, it will be null.
	FailoverInProgress *bool `json:"failoverInProgress,omitempty"`
	// LargeFileSharesState - Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. Possible values include: 'Disabled', 'Enabled'
	LargeFileSharesState LargeFileSharesState `json:"largeFileSharesState,omitempty"`
	// AllowBlobPublicAccess - Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property.
	AllowBlobPublicAccess *bool `json:"allowBlobPublicAccess,omitempty"`
	// MinimumTLSVersion - Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. Possible values include: 'TLS10', 'TLS11', 'TLS12'
	MinimumTLSVersion MinimumTLSVersion `json:"minimumTlsVersion,omitempty"`
}

AccountProperties properties of the storage account.

func (AccountProperties) MarshalJSON

func (ap AccountProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountProperties.

type AccountPropertiesCreateParameters

type AccountPropertiesCreateParameters struct {
	// 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"`
	// Encryption - Not applicable. Azure Storage encryption is enabled for all storage accounts and cannot be disabled.
	Encryption *Encryption `json:"encryption,omitempty"`
	// NetworkRuleSet - Network rule set
	NetworkRuleSet *NetworkRuleSet `json:"networkAcls,omitempty"`
	// AccessTier - Required for storage accounts where kind = BlobStorage. The access tier used for billing. Possible values include: 'Hot', 'Cool'
	AccessTier AccessTier `json:"accessTier,omitempty"`
	// AzureFilesIdentityBasedAuthentication - Provides the identity based authentication settings for Azure Files.
	AzureFilesIdentityBasedAuthentication *AzureFilesIdentityBasedAuthentication `json:"azureFilesIdentityBasedAuthentication,omitempty"`
	// EnableHTTPSTrafficOnly - Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01.
	EnableHTTPSTrafficOnly *bool `json:"supportsHttpsTrafficOnly,omitempty"`
	// IsHnsEnabled - Account HierarchicalNamespace enabled if sets to true.
	IsHnsEnabled *bool `json:"isHnsEnabled,omitempty"`
	// LargeFileSharesState - Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. Possible values include: 'Disabled', 'Enabled'
	LargeFileSharesState LargeFileSharesState `json:"largeFileSharesState,omitempty"`
	// AllowBlobPublicAccess - Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property.
	AllowBlobPublicAccess *bool `json:"allowBlobPublicAccess,omitempty"`
	// MinimumTLSVersion - Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. Possible values include: 'TLS10', 'TLS11', 'TLS12'
	MinimumTLSVersion MinimumTLSVersion `json:"minimumTlsVersion,omitempty"`
}

AccountPropertiesCreateParameters the parameters used to create the storage account.

type AccountPropertiesUpdateParameters

type AccountPropertiesUpdateParameters struct {
	// CustomDomain - Custom domain assigned to the storage account by the user. 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"`
	// Encryption - Provides the encryption settings on the account. The default setting is unencrypted.
	Encryption *Encryption `json:"encryption,omitempty"`
	// AccessTier - Required for storage accounts where kind = BlobStorage. The access tier used for billing. Possible values include: 'Hot', 'Cool'
	AccessTier AccessTier `json:"accessTier,omitempty"`
	// AzureFilesIdentityBasedAuthentication - Provides the identity based authentication settings for Azure Files.
	AzureFilesIdentityBasedAuthentication *AzureFilesIdentityBasedAuthentication `json:"azureFilesIdentityBasedAuthentication,omitempty"`
	// EnableHTTPSTrafficOnly - Allows https traffic only to storage service if sets to true.
	EnableHTTPSTrafficOnly *bool `json:"supportsHttpsTrafficOnly,omitempty"`
	// NetworkRuleSet - Network rule set
	NetworkRuleSet *NetworkRuleSet `json:"networkAcls,omitempty"`
	// LargeFileSharesState - Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. Possible values include: 'Disabled', 'Enabled'
	LargeFileSharesState LargeFileSharesState `json:"largeFileSharesState,omitempty"`
	// AllowBlobPublicAccess - Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property.
	AllowBlobPublicAccess *bool `json:"allowBlobPublicAccess,omitempty"`
	// MinimumTLSVersion - Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. Possible values include: 'TLS10', 'TLS11', 'TLS12'
	MinimumTLSVersion MinimumTLSVersion `json:"minimumTlsVersion,omitempty"`
}

AccountPropertiesUpdateParameters the parameters used when updating a storage account.

type AccountRegenerateKeyParameters

type AccountRegenerateKeyParameters struct {
	// KeyName - The name of storage keys that want to be regenerated, possible values are key1, key2, kerb1, kerb2.
	KeyName *string `json:"keyName,omitempty"`
}

AccountRegenerateKeyParameters the parameters used to regenerate the storage account key.

type AccountSasParameters

type AccountSasParameters struct {
	// Services - The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). Possible values include: 'B', 'Q', 'T', 'F'
	Services Services `json:"signedServices,omitempty"`
	// ResourceTypes - The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. Possible values include: 'SignedResourceTypesS', 'SignedResourceTypesC', 'SignedResourceTypesO'
	ResourceTypes SignedResourceTypes `json:"signedResourceTypes,omitempty"`
	// Permissions - The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). Possible values include: 'R', 'D', 'W', 'L', 'A', 'C', 'U', 'P'
	Permissions Permissions `json:"signedPermission,omitempty"`
	// IPAddressOrRange - An IP address or a range of IP addresses from which to accept requests.
	IPAddressOrRange *string `json:"signedIp,omitempty"`
	// Protocols - The protocol permitted for a request made with the account SAS. Possible values include: 'Httpshttp', 'HTTPS'
	Protocols HTTPProtocol `json:"signedProtocol,omitempty"`
	// SharedAccessStartTime - The time at which the SAS becomes valid.
	SharedAccessStartTime *date.Time `json:"signedStart,omitempty"`
	// SharedAccessExpiryTime - The time at which the shared access signature becomes invalid.
	SharedAccessExpiryTime *date.Time `json:"signedExpiry,omitempty"`
	// KeyToSign - The key to sign the account SAS token with.
	KeyToSign *string `json:"keyToSign,omitempty"`
}

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

type AccountStatus

type AccountStatus string

AccountStatus enumerates the values for account status.

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

func PossibleAccountStatusValues

func PossibleAccountStatusValues() []AccountStatus

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

type AccountUpdateParameters

type AccountUpdateParameters struct {
	// Sku - Gets or sets the SKU name. Note that the SKU name cannot be updated to Standard_ZRS, Premium_LRS or Premium_ZRS, nor can accounts of those SKU names be updated to any other value.
	Sku *Sku `json:"sku,omitempty"`
	// Tags - Gets or sets a list of key value pairs that describe the resource. These tags can be used in 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 no greater in length than 128 characters and a value no greater in length than 256 characters.
	Tags map[string]*string `json:"tags"`
	// Identity - The identity of the resource.
	Identity *Identity `json:"identity,omitempty"`
	// AccountPropertiesUpdateParameters - The parameters used when updating a storage account.
	*AccountPropertiesUpdateParameters `json:"properties,omitempty"`
	// Kind - Optional. Indicates the type of storage account. Currently only StorageV2 value supported by server. Possible values include: 'Storage', 'StorageV2', 'BlobStorage', 'FileStorage', 'BlockBlobStorage'
	Kind Kind `json:"kind,omitempty"`
}

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

func (AccountUpdateParameters) MarshalJSON

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

MarshalJSON is the custom marshaler for AccountUpdateParameters.

func (*AccountUpdateParameters) UnmarshalJSON

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

UnmarshalJSON is the custom unmarshaler for AccountUpdateParameters struct.

type AccountsClient

type AccountsClient struct {
	BaseClient
}

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (AccountsClient) CheckNameAvailability

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

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

func (client AccountsClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, parameters AccountCreateParameters) (*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) (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

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

func (client AccountsClient) DeletePreparer(ctx context.Context, 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) Failover

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

Failover failover request can be triggered for a storage account in case of availability issues. The failover occurs from the storage account's primary cluster to secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover. 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) FailoverPreparer

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

FailoverPreparer prepares the Failover request.

func (AccountsClient) FailoverResponder

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

FailoverResponder handles the response to the Failover request. The method always closes the http.Response Body.

func (AccountsClient) FailoverSender

func (client AccountsClient) FailoverSender(req *http.Request) (future AccountsFailoverFuture, err error)

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

func (AccountsClient) GetProperties

func (client AccountsClient) GetProperties(ctx context.Context, resourceGroupName string, accountName string, expand AccountExpand) (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. expand - may be used to expand the properties within account's properties. By default, data is not included when fetching properties. Currently we only support geoReplicationStats.

func (AccountsClient) GetPropertiesPreparer

func (client AccountsClient) GetPropertiesPreparer(ctx context.Context, resourceGroupName string, accountName string, expand AccountExpand) (*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(ctx context.Context) (result AccountListResultPage, 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(ctx context.Context, resourceGroupName string, accountName string, parameters AccountSasParameters) (result ListAccountSasResponse, err error)

ListAccountSAS list SAS credentials of a 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. parameters - the parameters to provide to list SAS credentials for the storage account.

func (AccountsClient) ListAccountSASPreparer

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

func (client AccountsClient) ListByResourceGroupPreparer(ctx context.Context, 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) ListComplete

func (client AccountsClient) ListComplete(ctx context.Context) (result AccountListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (AccountsClient) ListKeys

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

ListKeys lists the access keys or Kerberos keys (if active directory enabled) 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. expand - specifies type of the key to be listed. Possible value is kerb.

func (AccountsClient) ListKeysPreparer

func (client AccountsClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, accountName string, expand ListKeyExpand) (*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(ctx context.Context) (*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(ctx context.Context, resourceGroupName string, accountName string, parameters ServiceSasParameters) (result ListServiceSasResponse, err error)

ListServiceSAS list service SAS credentials of a specific resource. 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 to list service SAS credentials.

func (AccountsClient) ListServiceSASPreparer

func (client AccountsClient) ListServiceSASPreparer(ctx context.Context, 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(ctx context.Context, resourceGroupName string, accountName string, regenerateKey AccountRegenerateKeyParameters) (result AccountListKeysResult, err error)

RegenerateKey regenerates one of the access keys or Kerberos 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, key2, kerb1, kerb2.

func (AccountsClient) RegenerateKeyPreparer

func (client AccountsClient) RegenerateKeyPreparer(ctx context.Context, 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) RevokeUserDelegationKeys

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

RevokeUserDelegationKeys revoke user delegation 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) RevokeUserDelegationKeysPreparer

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

RevokeUserDelegationKeysPreparer prepares the RevokeUserDelegationKeys request.

func (AccountsClient) RevokeUserDelegationKeysResponder

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

RevokeUserDelegationKeysResponder handles the response to the RevokeUserDelegationKeys request. The method always closes the http.Response Body.

func (AccountsClient) RevokeUserDelegationKeysSender

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

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

func (AccountsClient) Update

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

func (client AccountsClient) UpdatePreparer(ctx context.Context, 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 AccountsCreateFuture

type AccountsCreateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(AccountsClient) (Account, error)
}

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

func (*AccountsCreateFuture) UnmarshalJSON

func (future *AccountsCreateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type AccountsFailoverFuture

type AccountsFailoverFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(AccountsClient) (autorest.Response, error)
}

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

func (*AccountsFailoverFuture) UnmarshalJSON

func (future *AccountsFailoverFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type Action

type Action string

Action enumerates the values for action.

const (
	// Allow ...
	Allow Action = "Allow"
)

func PossibleActionValues

func PossibleActionValues() []Action

PossibleActionValues returns an array of possible values for the Action const type.

type Action1

type Action1 string

Action1 enumerates the values for action 1.

const (
	// Acquire ...
	Acquire Action1 = "Acquire"
	// Break ...
	Break Action1 = "Break"
	// Change ...
	Change Action1 = "Change"
	// Release ...
	Release Action1 = "Release"
	// Renew ...
	Renew Action1 = "Renew"
)

func PossibleAction1Values

func PossibleAction1Values() []Action1

PossibleAction1Values returns an array of possible values for the Action1 const type.

type ActiveDirectoryProperties

type ActiveDirectoryProperties struct {
	// DomainName - Specifies the primary domain that the AD DNS server is authoritative for.
	DomainName *string `json:"domainName,omitempty"`
	// NetBiosDomainName - Specifies the NetBIOS domain name.
	NetBiosDomainName *string `json:"netBiosDomainName,omitempty"`
	// ForestName - Specifies the Active Directory forest to get.
	ForestName *string `json:"forestName,omitempty"`
	// DomainGUID - Specifies the domain GUID.
	DomainGUID *string `json:"domainGuid,omitempty"`
	// DomainSid - Specifies the security identifier (SID).
	DomainSid *string `json:"domainSid,omitempty"`
	// AzureStorageSid - Specifies the security identifier (SID) for Azure Storage.
	AzureStorageSid *string `json:"azureStorageSid,omitempty"`
}

ActiveDirectoryProperties settings properties for Active Directory (AD).

type AzureEntityResource

type AzureEntityResource struct {
	// Etag - READ-ONLY; Resource Etag.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.

func (AzureEntityResource) MarshalJSON

func (aer AzureEntityResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AzureEntityResource.

type AzureFilesIdentityBasedAuthentication

type AzureFilesIdentityBasedAuthentication struct {
	// DirectoryServiceOptions - Indicates the directory service used. Possible values include: 'DirectoryServiceOptionsNone', 'DirectoryServiceOptionsAADDS', 'DirectoryServiceOptionsAD'
	DirectoryServiceOptions DirectoryServiceOptions `json:"directoryServiceOptions,omitempty"`
	// ActiveDirectoryProperties - Required if choose AD.
	ActiveDirectoryProperties *ActiveDirectoryProperties `json:"activeDirectoryProperties,omitempty"`
}

AzureFilesIdentityBasedAuthentication settings for Azure Files identity based authentication.

type BaseClient

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

BaseClient is the base client for Storage.

func New

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type BlobContainer

type BlobContainer struct {
	autorest.Response `json:"-"`
	// ContainerProperties - Properties of the blob container.
	*ContainerProperties `json:"properties,omitempty"`
	// Etag - READ-ONLY; Resource Etag.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

BlobContainer properties of the blob container, including Id, resource name, resource type, Etag.

func (BlobContainer) MarshalJSON

func (bc BlobContainer) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BlobContainer.

func (*BlobContainer) UnmarshalJSON

func (bc *BlobContainer) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for BlobContainer struct.

type BlobContainersClient

type BlobContainersClient struct {
	BaseClient
}

BlobContainersClient is the the Azure Storage Management API.

func NewBlobContainersClient

func NewBlobContainersClient(subscriptionID string) BlobContainersClient

NewBlobContainersClient creates an instance of the BlobContainersClient client.

func NewBlobContainersClientWithBaseURI

func NewBlobContainersClientWithBaseURI(baseURI string, subscriptionID string) BlobContainersClient

NewBlobContainersClientWithBaseURI creates an instance of the BlobContainersClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (BlobContainersClient) ClearLegalHold

func (client BlobContainersClient) ClearLegalHold(ctx context.Context, resourceGroupName string, accountName string, containerName string, legalHold LegalHold) (result LegalHold, err error)

ClearLegalHold clears legal hold tags. Clearing the same or non-existent tag results in an idempotent operation. ClearLegalHold clears out only the specified tags in the request. 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. containerName - the name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. legalHold - the LegalHold property that will be clear from a blob container.

func (BlobContainersClient) ClearLegalHoldPreparer

func (client BlobContainersClient) ClearLegalHoldPreparer(ctx context.Context, resourceGroupName string, accountName string, containerName string, legalHold LegalHold) (*http.Request, error)

ClearLegalHoldPreparer prepares the ClearLegalHold request.

func (BlobContainersClient) ClearLegalHoldResponder

func (client BlobContainersClient) ClearLegalHoldResponder(resp *http.Response) (result LegalHold, err error)

ClearLegalHoldResponder handles the response to the ClearLegalHold request. The method always closes the http.Response Body.

func (BlobContainersClient) ClearLegalHoldSender

func (client BlobContainersClient) ClearLegalHoldSender(req *http.Request) (*http.Response, error)

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

func (BlobContainersClient) Create

func (client BlobContainersClient) Create(ctx context.Context, resourceGroupName string, accountName string, containerName string, blobContainer BlobContainer) (result BlobContainer, err error)

Create creates a new container under the specified account as described by request body. The container resource includes metadata and properties for that container. It does not include a list of the blobs contained by the container. 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. containerName - the name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. blobContainer - properties of the blob container to create.

func (BlobContainersClient) CreateOrUpdateImmutabilityPolicy

func (client BlobContainersClient) CreateOrUpdateImmutabilityPolicy(ctx context.Context, resourceGroupName string, accountName string, containerName string, parameters *ImmutabilityPolicy, ifMatch string) (result ImmutabilityPolicy, err error)

CreateOrUpdateImmutabilityPolicy creates or updates an unlocked immutability policy. ETag in If-Match is honored if given but not required for this operation. 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. containerName - the name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. parameters - the ImmutabilityPolicy Properties that will be created or updated to a blob container. ifMatch - the entity state (ETag) version of the immutability policy to update. A value of "*" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied.

func (BlobContainersClient) CreateOrUpdateImmutabilityPolicyPreparer

func (client BlobContainersClient) CreateOrUpdateImmutabilityPolicyPreparer(ctx context.Context, resourceGroupName string, accountName string, containerName string, parameters *ImmutabilityPolicy, ifMatch string) (*http.Request, error)

CreateOrUpdateImmutabilityPolicyPreparer prepares the CreateOrUpdateImmutabilityPolicy request.

func (BlobContainersClient) CreateOrUpdateImmutabilityPolicyResponder

func (client BlobContainersClient) CreateOrUpdateImmutabilityPolicyResponder(resp *http.Response) (result ImmutabilityPolicy, err error)

CreateOrUpdateImmutabilityPolicyResponder handles the response to the CreateOrUpdateImmutabilityPolicy request. The method always closes the http.Response Body.

func (BlobContainersClient) CreateOrUpdateImmutabilityPolicySender

func (client BlobContainersClient) CreateOrUpdateImmutabilityPolicySender(req *http.Request) (*http.Response, error)

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

func (BlobContainersClient) CreatePreparer

func (client BlobContainersClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, containerName string, blobContainer BlobContainer) (*http.Request, error)

CreatePreparer prepares the Create request.

func (BlobContainersClient) CreateResponder

func (client BlobContainersClient) CreateResponder(resp *http.Response) (result BlobContainer, err error)

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

func (BlobContainersClient) CreateSender

func (client BlobContainersClient) 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 (BlobContainersClient) Delete

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

Delete deletes specified container under its 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. containerName - the name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.

func (BlobContainersClient) DeleteImmutabilityPolicy

func (client BlobContainersClient) DeleteImmutabilityPolicy(ctx context.Context, resourceGroupName string, accountName string, containerName string, ifMatch string) (result ImmutabilityPolicy, err error)

DeleteImmutabilityPolicy aborts an unlocked immutability policy. The response of delete has immutabilityPeriodSinceCreationInDays set to 0. ETag in If-Match is required for this operation. Deleting a locked immutability policy is not allowed, only way is to delete the container after deleting all blobs inside the container. 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. containerName - the name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. ifMatch - the entity state (ETag) version of the immutability policy to update. A value of "*" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied.

func (BlobContainersClient) DeleteImmutabilityPolicyPreparer

func (client BlobContainersClient) DeleteImmutabilityPolicyPreparer(ctx context.Context, resourceGroupName string, accountName string, containerName string, ifMatch string) (*http.Request, error)

DeleteImmutabilityPolicyPreparer prepares the DeleteImmutabilityPolicy request.

func (BlobContainersClient) DeleteImmutabilityPolicyResponder

func (client BlobContainersClient) DeleteImmutabilityPolicyResponder(resp *http.Response) (result ImmutabilityPolicy, err error)

DeleteImmutabilityPolicyResponder handles the response to the DeleteImmutabilityPolicy request. The method always closes the http.Response Body.

func (BlobContainersClient) DeleteImmutabilityPolicySender

func (client BlobContainersClient) DeleteImmutabilityPolicySender(req *http.Request) (*http.Response, error)

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

func (BlobContainersClient) DeletePreparer

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

DeletePreparer prepares the Delete request.

func (BlobContainersClient) DeleteResponder

func (client BlobContainersClient) 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 (BlobContainersClient) DeleteSender

func (client BlobContainersClient) 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 (BlobContainersClient) ExtendImmutabilityPolicy

func (client BlobContainersClient) ExtendImmutabilityPolicy(ctx context.Context, resourceGroupName string, accountName string, containerName string, ifMatch string, parameters *ImmutabilityPolicy) (result ImmutabilityPolicy, err error)

ExtendImmutabilityPolicy extends the immutabilityPeriodSinceCreationInDays of a locked immutabilityPolicy. The only action allowed on a Locked policy will be this action. ETag in If-Match is required for this operation. 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. containerName - the name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. ifMatch - the entity state (ETag) version of the immutability policy to update. A value of "*" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied. parameters - the ImmutabilityPolicy Properties that will be extended for a blob container.

func (BlobContainersClient) ExtendImmutabilityPolicyPreparer

func (client BlobContainersClient) ExtendImmutabilityPolicyPreparer(ctx context.Context, resourceGroupName string, accountName string, containerName string, ifMatch string, parameters *ImmutabilityPolicy) (*http.Request, error)

ExtendImmutabilityPolicyPreparer prepares the ExtendImmutabilityPolicy request.

func (BlobContainersClient) ExtendImmutabilityPolicyResponder

func (client BlobContainersClient) ExtendImmutabilityPolicyResponder(resp *http.Response) (result ImmutabilityPolicy, err error)

ExtendImmutabilityPolicyResponder handles the response to the ExtendImmutabilityPolicy request. The method always closes the http.Response Body.

func (BlobContainersClient) ExtendImmutabilityPolicySender

func (client BlobContainersClient) ExtendImmutabilityPolicySender(req *http.Request) (*http.Response, error)

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

func (BlobContainersClient) Get

func (client BlobContainersClient) Get(ctx context.Context, resourceGroupName string, accountName string, containerName string) (result BlobContainer, err error)

Get gets properties of a specified container. 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. containerName - the name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.

func (BlobContainersClient) GetImmutabilityPolicy

func (client BlobContainersClient) GetImmutabilityPolicy(ctx context.Context, resourceGroupName string, accountName string, containerName string, ifMatch string) (result ImmutabilityPolicy, err error)

GetImmutabilityPolicy gets the existing immutability policy along with the corresponding ETag in response headers and body. 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. containerName - the name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. ifMatch - the entity state (ETag) version of the immutability policy to update. A value of "*" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied.

func (BlobContainersClient) GetImmutabilityPolicyPreparer

func (client BlobContainersClient) GetImmutabilityPolicyPreparer(ctx context.Context, resourceGroupName string, accountName string, containerName string, ifMatch string) (*http.Request, error)

GetImmutabilityPolicyPreparer prepares the GetImmutabilityPolicy request.

func (BlobContainersClient) GetImmutabilityPolicyResponder

func (client BlobContainersClient) GetImmutabilityPolicyResponder(resp *http.Response) (result ImmutabilityPolicy, err error)

GetImmutabilityPolicyResponder handles the response to the GetImmutabilityPolicy request. The method always closes the http.Response Body.

func (BlobContainersClient) GetImmutabilityPolicySender

func (client BlobContainersClient) GetImmutabilityPolicySender(req *http.Request) (*http.Response, error)

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

func (BlobContainersClient) GetPreparer

func (client BlobContainersClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, containerName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (BlobContainersClient) GetResponder

func (client BlobContainersClient) GetResponder(resp *http.Response) (result BlobContainer, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (BlobContainersClient) GetSender

func (client BlobContainersClient) GetSender(req *http.Request) (*http.Response, error)

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

func (BlobContainersClient) Lease

func (client BlobContainersClient) Lease(ctx context.Context, resourceGroupName string, accountName string, containerName string, parameters *LeaseContainerRequest) (result LeaseContainerResponse, err error)

Lease the Lease Container operation establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite. 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. containerName - the name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. parameters - lease Container request body.

func (BlobContainersClient) LeasePreparer

func (client BlobContainersClient) LeasePreparer(ctx context.Context, resourceGroupName string, accountName string, containerName string, parameters *LeaseContainerRequest) (*http.Request, error)

LeasePreparer prepares the Lease request.

func (BlobContainersClient) LeaseResponder

func (client BlobContainersClient) LeaseResponder(resp *http.Response) (result LeaseContainerResponse, err error)

LeaseResponder handles the response to the Lease request. The method always closes the http.Response Body.

func (BlobContainersClient) LeaseSender

func (client BlobContainersClient) LeaseSender(req *http.Request) (*http.Response, error)

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

func (BlobContainersClient) List

func (client BlobContainersClient) List(ctx context.Context, resourceGroupName string, accountName string, skipToken string, maxpagesize string, filter string) (result ListContainerItemsPage, err error)

List lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token. 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. skipToken - optional. Continuation token for the list operation. maxpagesize - optional. Specified maximum number of containers that can be included in the list. filter - optional. When specified, only container names starting with the filter will be listed.

func (BlobContainersClient) ListComplete

func (client BlobContainersClient) ListComplete(ctx context.Context, resourceGroupName string, accountName string, skipToken string, maxpagesize string, filter string) (result ListContainerItemsIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (BlobContainersClient) ListPreparer

func (client BlobContainersClient) ListPreparer(ctx context.Context, resourceGroupName string, accountName string, skipToken string, maxpagesize string, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (BlobContainersClient) ListResponder

func (client BlobContainersClient) ListResponder(resp *http.Response) (result ListContainerItems, err error)

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

func (BlobContainersClient) ListSender

func (client BlobContainersClient) 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 (BlobContainersClient) LockImmutabilityPolicy

func (client BlobContainersClient) LockImmutabilityPolicy(ctx context.Context, resourceGroupName string, accountName string, containerName string, ifMatch string) (result ImmutabilityPolicy, err error)

LockImmutabilityPolicy sets the ImmutabilityPolicy to Locked state. The only action allowed on a Locked policy is ExtendImmutabilityPolicy action. ETag in If-Match is required for this operation. 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. containerName - the name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. ifMatch - the entity state (ETag) version of the immutability policy to update. A value of "*" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied.

func (BlobContainersClient) LockImmutabilityPolicyPreparer

func (client BlobContainersClient) LockImmutabilityPolicyPreparer(ctx context.Context, resourceGroupName string, accountName string, containerName string, ifMatch string) (*http.Request, error)

LockImmutabilityPolicyPreparer prepares the LockImmutabilityPolicy request.

func (BlobContainersClient) LockImmutabilityPolicyResponder

func (client BlobContainersClient) LockImmutabilityPolicyResponder(resp *http.Response) (result ImmutabilityPolicy, err error)

LockImmutabilityPolicyResponder handles the response to the LockImmutabilityPolicy request. The method always closes the http.Response Body.

func (BlobContainersClient) LockImmutabilityPolicySender

func (client BlobContainersClient) LockImmutabilityPolicySender(req *http.Request) (*http.Response, error)

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

func (BlobContainersClient) SetLegalHold

func (client BlobContainersClient) SetLegalHold(ctx context.Context, resourceGroupName string, accountName string, containerName string, legalHold LegalHold) (result LegalHold, err error)

SetLegalHold sets legal hold tags. Setting the same tag results in an idempotent operation. SetLegalHold follows an append pattern and does not clear out the existing tags that are not specified in the request. 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. containerName - the name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. legalHold - the LegalHold property that will be set to a blob container.

func (BlobContainersClient) SetLegalHoldPreparer

func (client BlobContainersClient) SetLegalHoldPreparer(ctx context.Context, resourceGroupName string, accountName string, containerName string, legalHold LegalHold) (*http.Request, error)

SetLegalHoldPreparer prepares the SetLegalHold request.

func (BlobContainersClient) SetLegalHoldResponder

func (client BlobContainersClient) SetLegalHoldResponder(resp *http.Response) (result LegalHold, err error)

SetLegalHoldResponder handles the response to the SetLegalHold request. The method always closes the http.Response Body.

func (BlobContainersClient) SetLegalHoldSender

func (client BlobContainersClient) SetLegalHoldSender(req *http.Request) (*http.Response, error)

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

func (BlobContainersClient) Update

func (client BlobContainersClient) Update(ctx context.Context, resourceGroupName string, accountName string, containerName string, blobContainer BlobContainer) (result BlobContainer, err error)

Update updates container properties as specified in request body. Properties not mentioned in the request will be unchanged. Update fails if the specified container doesn't already exist. 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. containerName - the name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. blobContainer - properties to update for the blob container.

func (BlobContainersClient) UpdatePreparer

func (client BlobContainersClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, containerName string, blobContainer BlobContainer) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (BlobContainersClient) UpdateResponder

func (client BlobContainersClient) UpdateResponder(resp *http.Response) (result BlobContainer, err error)

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

func (BlobContainersClient) UpdateSender

func (client BlobContainersClient) 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 BlobServiceItems

type BlobServiceItems struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of blob services returned.
	Value *[]BlobServiceProperties `json:"value,omitempty"`
}

BlobServiceItems ...

func (BlobServiceItems) MarshalJSON

func (bsi BlobServiceItems) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BlobServiceItems.

type BlobServiceProperties

type BlobServiceProperties struct {
	autorest.Response `json:"-"`
	// BlobServicePropertiesProperties - The properties of a storage account’s Blob service.
	*BlobServicePropertiesProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

BlobServiceProperties the properties of a storage account’s Blob service.

func (BlobServiceProperties) MarshalJSON

func (bsp BlobServiceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BlobServiceProperties.

func (*BlobServiceProperties) UnmarshalJSON

func (bsp *BlobServiceProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for BlobServiceProperties struct.

type BlobServicePropertiesProperties

type BlobServicePropertiesProperties struct {
	// Cors - Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service.
	Cors *CorsRules `json:"cors,omitempty"`
	// DefaultServiceVersion - DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions.
	DefaultServiceVersion *string `json:"defaultServiceVersion,omitempty"`
	// DeleteRetentionPolicy - The blob service properties for soft delete.
	DeleteRetentionPolicy *DeleteRetentionPolicy `json:"deleteRetentionPolicy,omitempty"`
	// AutomaticSnapshotPolicyEnabled - Automatic Snapshot is enabled if set to true.
	AutomaticSnapshotPolicyEnabled *bool `json:"automaticSnapshotPolicyEnabled,omitempty"`
	// ChangeFeed - The blob service properties for change feed events.
	ChangeFeed *ChangeFeed `json:"changeFeed,omitempty"`
}

BlobServicePropertiesProperties the properties of a storage account’s Blob service.

type BlobServicesClient

type BlobServicesClient struct {
	BaseClient
}

BlobServicesClient is the the Azure Storage Management API.

func NewBlobServicesClient

func NewBlobServicesClient(subscriptionID string) BlobServicesClient

NewBlobServicesClient creates an instance of the BlobServicesClient client.

func NewBlobServicesClientWithBaseURI

func NewBlobServicesClientWithBaseURI(baseURI string, subscriptionID string) BlobServicesClient

NewBlobServicesClientWithBaseURI creates an instance of the BlobServicesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (BlobServicesClient) GetServiceProperties

func (client BlobServicesClient) GetServiceProperties(ctx context.Context, resourceGroupName string, accountName string) (result BlobServiceProperties, err error)

GetServiceProperties gets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. 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 (BlobServicesClient) GetServicePropertiesPreparer

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

GetServicePropertiesPreparer prepares the GetServiceProperties request.

func (BlobServicesClient) GetServicePropertiesResponder

func (client BlobServicesClient) GetServicePropertiesResponder(resp *http.Response) (result BlobServiceProperties, err error)

GetServicePropertiesResponder handles the response to the GetServiceProperties request. The method always closes the http.Response Body.

func (BlobServicesClient) GetServicePropertiesSender

func (client BlobServicesClient) GetServicePropertiesSender(req *http.Request) (*http.Response, error)

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

func (BlobServicesClient) List

func (client BlobServicesClient) List(ctx context.Context, resourceGroupName string, accountName string) (result BlobServiceItems, err error)

List list blob services of storage account. It returns a collection of one object named default. 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 (BlobServicesClient) ListPreparer

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

ListPreparer prepares the List request.

func (BlobServicesClient) ListResponder

func (client BlobServicesClient) ListResponder(resp *http.Response) (result BlobServiceItems, err error)

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

func (BlobServicesClient) ListSender

func (client BlobServicesClient) 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 (BlobServicesClient) SetServiceProperties

func (client BlobServicesClient) SetServiceProperties(ctx context.Context, resourceGroupName string, accountName string, parameters BlobServiceProperties) (result BlobServiceProperties, err error)

SetServiceProperties sets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. 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 properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.

func (BlobServicesClient) SetServicePropertiesPreparer

func (client BlobServicesClient) SetServicePropertiesPreparer(ctx context.Context, resourceGroupName string, accountName string, parameters BlobServiceProperties) (*http.Request, error)

SetServicePropertiesPreparer prepares the SetServiceProperties request.

func (BlobServicesClient) SetServicePropertiesResponder

func (client BlobServicesClient) SetServicePropertiesResponder(resp *http.Response) (result BlobServiceProperties, err error)

SetServicePropertiesResponder handles the response to the SetServiceProperties request. The method always closes the http.Response Body.

func (BlobServicesClient) SetServicePropertiesSender

func (client BlobServicesClient) SetServicePropertiesSender(req *http.Request) (*http.Response, error)

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

type Bypass

type Bypass string

Bypass enumerates the values for bypass.

const (
	// AzureServices ...
	AzureServices Bypass = "AzureServices"
	// Logging ...
	Logging Bypass = "Logging"
	// Metrics ...
	Metrics Bypass = "Metrics"
	// None ...
	None Bypass = "None"
)

func PossibleBypassValues

func PossibleBypassValues() []Bypass

PossibleBypassValues returns an array of possible values for the Bypass const type.

type ChangeFeed

type ChangeFeed struct {
	// Enabled - Indicates whether change feed event logging is enabled for the Blob service.
	Enabled *bool `json:"enabled,omitempty"`
}

ChangeFeed the blob service properties for change feed events.

type CheckNameAvailabilityResult

type CheckNameAvailabilityResult struct {
	autorest.Response `json:"-"`
	// NameAvailable - READ-ONLY; Gets a 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 - READ-ONLY; Gets 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 - READ-ONLY; Gets an error message explaining the Reason value in more detail.
	Message *string `json:"message,omitempty"`
}

CheckNameAvailabilityResult the CheckNameAvailability operation response.

func (CheckNameAvailabilityResult) MarshalJSON

func (cnar CheckNameAvailabilityResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CheckNameAvailabilityResult.

type CloudError

type CloudError struct {
	Error *CloudErrorBody `json:"error,omitempty"`
}

CloudError an error response from the Storage service.

type CloudErrorBody

type CloudErrorBody struct {
	// Code - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
	Code *string `json:"code,omitempty"`
	// Message - A message describing the error, intended to be suitable for display in a user interface.
	Message *string `json:"message,omitempty"`
	// Target - The target of the particular error. For example, the name of the property in error.
	Target *string `json:"target,omitempty"`
	// Details - A list of additional details about the error.
	Details *[]CloudErrorBody `json:"details,omitempty"`
}

CloudErrorBody an error response from the Storage service.

type ContainerProperties

type ContainerProperties struct {
	// PublicAccess - Specifies whether data in the container may be accessed publicly and the level of access. Possible values include: 'PublicAccessContainer', 'PublicAccessBlob', 'PublicAccessNone'
	PublicAccess PublicAccess `json:"publicAccess,omitempty"`
	// LastModifiedTime - READ-ONLY; Returns the date and time the container was last modified.
	LastModifiedTime *date.Time `json:"lastModifiedTime,omitempty"`
	// LeaseStatus - READ-ONLY; The lease status of the container. Possible values include: 'LeaseStatusLocked', 'LeaseStatusUnlocked'
	LeaseStatus LeaseStatus `json:"leaseStatus,omitempty"`
	// LeaseState - READ-ONLY; Lease state of the container. Possible values include: 'LeaseStateAvailable', 'LeaseStateLeased', 'LeaseStateExpired', 'LeaseStateBreaking', 'LeaseStateBroken'
	LeaseState LeaseState `json:"leaseState,omitempty"`
	// LeaseDuration - READ-ONLY; Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. Possible values include: 'Infinite', 'Fixed'
	LeaseDuration LeaseDuration `json:"leaseDuration,omitempty"`
	// Metadata - A name-value pair to associate with the container as metadata.
	Metadata map[string]*string `json:"metadata"`
	// ImmutabilityPolicy - READ-ONLY; The ImmutabilityPolicy property of the container.
	ImmutabilityPolicy *ImmutabilityPolicyProperties `json:"immutabilityPolicy,omitempty"`
	// LegalHold - READ-ONLY; The LegalHold property of the container.
	LegalHold *LegalHoldProperties `json:"legalHold,omitempty"`
	// HasLegalHold - READ-ONLY; The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.
	HasLegalHold *bool `json:"hasLegalHold,omitempty"`
	// HasImmutabilityPolicy - READ-ONLY; The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container.
	HasImmutabilityPolicy *bool `json:"hasImmutabilityPolicy,omitempty"`
}

ContainerProperties the properties of a container.

func (ContainerProperties) MarshalJSON

func (cp ContainerProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ContainerProperties.

type CorsRule

type CorsRule struct {
	// AllowedOrigins - Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains
	AllowedOrigins *[]string `json:"allowedOrigins,omitempty"`
	// AllowedMethods - Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.
	AllowedMethods *[]string `json:"allowedMethods,omitempty"`
	// MaxAgeInSeconds - Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.
	MaxAgeInSeconds *int32 `json:"maxAgeInSeconds,omitempty"`
	// ExposedHeaders - Required if CorsRule element is present. A list of response headers to expose to CORS clients.
	ExposedHeaders *[]string `json:"exposedHeaders,omitempty"`
	// AllowedHeaders - Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.
	AllowedHeaders *[]string `json:"allowedHeaders,omitempty"`
}

CorsRule specifies a CORS rule for the Blob service.

type CorsRules

type CorsRules struct {
	// CorsRules - The List of CORS rules. You can include up to five CorsRule elements in the request.
	CorsRules *[]CorsRule `json:"corsRules,omitempty"`
}

CorsRules sets the CORS rules. You can include up to five CorsRule elements in the request.

type CustomDomain

type CustomDomain struct {
	// Name - Gets or sets the custom domain name assigned to the storage account. 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 DateAfterCreation

type DateAfterCreation struct {
	// DaysAfterCreationGreaterThan - Value indicating the age in days after creation
	DaysAfterCreationGreaterThan *float64 `json:"daysAfterCreationGreaterThan,omitempty"`
}

DateAfterCreation object to define the number of days after creation.

type DateAfterModification

type DateAfterModification struct {
	// DaysAfterModificationGreaterThan - Value indicating the age in days after last modification
	DaysAfterModificationGreaterThan *float64 `json:"daysAfterModificationGreaterThan,omitempty"`
}

DateAfterModification object to define the number of days after last modification.

type DefaultAction

type DefaultAction string

DefaultAction enumerates the values for default action.

const (
	// DefaultActionAllow ...
	DefaultActionAllow DefaultAction = "Allow"
	// DefaultActionDeny ...
	DefaultActionDeny DefaultAction = "Deny"
)

func PossibleDefaultActionValues

func PossibleDefaultActionValues() []DefaultAction

PossibleDefaultActionValues returns an array of possible values for the DefaultAction const type.

type DeleteRetentionPolicy

type DeleteRetentionPolicy struct {
	// Enabled - Indicates whether DeleteRetentionPolicy is enabled for the Blob service.
	Enabled *bool `json:"enabled,omitempty"`
	// Days - Indicates the number of days that the deleted blob should be retained. The minimum specified value can be 1 and the maximum value can be 365.
	Days *int32 `json:"days,omitempty"`
}

DeleteRetentionPolicy the blob service properties for soft delete.

type Dimension

type Dimension struct {
	// Name - Display name of dimension.
	Name *string `json:"name,omitempty"`
	// DisplayName - Display name of dimension.
	DisplayName *string `json:"displayName,omitempty"`
}

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

type DirectoryServiceOptions

type DirectoryServiceOptions string

DirectoryServiceOptions enumerates the values for directory service options.

const (
	// DirectoryServiceOptionsAADDS ...
	DirectoryServiceOptionsAADDS DirectoryServiceOptions = "AADDS"
	// DirectoryServiceOptionsAD ...
	DirectoryServiceOptionsAD DirectoryServiceOptions = "AD"
	// DirectoryServiceOptionsNone ...
	DirectoryServiceOptionsNone DirectoryServiceOptions = "None"
)

func PossibleDirectoryServiceOptionsValues

func PossibleDirectoryServiceOptionsValues() []DirectoryServiceOptions

PossibleDirectoryServiceOptionsValues returns an array of possible values for the DirectoryServiceOptions const type.

type Encryption

type Encryption struct {
	// Services - List of services which support encryption.
	Services *EncryptionServices `json:"services,omitempty"`
	// KeySource - The encryption keySource (provider). Possible values (case-insensitive):  Microsoft.Storage, Microsoft.Keyvault. Possible values include: 'MicrosoftStorage', 'MicrosoftKeyvault'
	KeySource KeySource `json:"keySource,omitempty"`
	// KeyVaultProperties - Properties provided by key vault.
	KeyVaultProperties *KeyVaultProperties `json:"keyvaultproperties,omitempty"`
}

Encryption the encryption settings on the storage account.

type EncryptionService

type EncryptionService struct {
	// Enabled - A boolean indicating whether or not the service encrypts the data as it is stored.
	Enabled *bool `json:"enabled,omitempty"`
	// LastEnabledTime - READ-ONLY; Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.
	LastEnabledTime *date.Time `json:"lastEnabledTime,omitempty"`
}

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

func (EncryptionService) MarshalJSON

func (es EncryptionService) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EncryptionService.

type EncryptionServices

type EncryptionServices struct {
	// Blob - The encryption function of the blob storage service.
	Blob *EncryptionService `json:"blob,omitempty"`
	// File - The encryption function of the file storage service.
	File *EncryptionService `json:"file,omitempty"`
	// Table - READ-ONLY; The encryption function of the table storage service.
	Table *EncryptionService `json:"table,omitempty"`
	// Queue - READ-ONLY; The encryption function of the queue storage service.
	Queue *EncryptionService `json:"queue,omitempty"`
}

EncryptionServices a list of services that support encryption.

func (EncryptionServices) MarshalJSON

func (es EncryptionServices) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EncryptionServices.

type Endpoints

type Endpoints struct {
	// Blob - READ-ONLY; Gets the blob endpoint.
	Blob *string `json:"blob,omitempty"`
	// Queue - READ-ONLY; Gets the queue endpoint.
	Queue *string `json:"queue,omitempty"`
	// Table - READ-ONLY; Gets the table endpoint.
	Table *string `json:"table,omitempty"`
	// File - READ-ONLY; Gets the file endpoint.
	File *string `json:"file,omitempty"`
	// Web - READ-ONLY; Gets the web endpoint.
	Web *string `json:"web,omitempty"`
	// Dfs - READ-ONLY; Gets the dfs endpoint.
	Dfs *string `json:"dfs,omitempty"`
}

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

func (Endpoints) MarshalJSON

func (e Endpoints) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Endpoints.

type FileServiceItems

type FileServiceItems struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of file services returned.
	Value *[]FileServiceProperties `json:"value,omitempty"`
}

FileServiceItems ...

func (FileServiceItems) MarshalJSON

func (fsi FileServiceItems) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for FileServiceItems.

type FileServiceProperties

type FileServiceProperties struct {
	autorest.Response `json:"-"`
	// FileServicePropertiesProperties - The properties of File services in storage account.
	*FileServicePropertiesProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

FileServiceProperties the properties of File services in storage account.

func (FileServiceProperties) MarshalJSON

func (fsp FileServiceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for FileServiceProperties.

func (*FileServiceProperties) UnmarshalJSON

func (fsp *FileServiceProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for FileServiceProperties struct.

type FileServicePropertiesProperties

type FileServicePropertiesProperties struct {
	// Cors - Specifies CORS rules for the File service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the File service.
	Cors *CorsRules `json:"cors,omitempty"`
}

FileServicePropertiesProperties the properties of File services in storage account.

type FileServicesClient

type FileServicesClient struct {
	BaseClient
}

FileServicesClient is the the Azure Storage Management API.

func NewFileServicesClient

func NewFileServicesClient(subscriptionID string) FileServicesClient

NewFileServicesClient creates an instance of the FileServicesClient client.

func NewFileServicesClientWithBaseURI

func NewFileServicesClientWithBaseURI(baseURI string, subscriptionID string) FileServicesClient

NewFileServicesClientWithBaseURI creates an instance of the FileServicesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (FileServicesClient) GetServiceProperties

func (client FileServicesClient) GetServiceProperties(ctx context.Context, resourceGroupName string, accountName string) (result FileServiceProperties, err error)

GetServiceProperties gets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules. 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 (FileServicesClient) GetServicePropertiesPreparer

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

GetServicePropertiesPreparer prepares the GetServiceProperties request.

func (FileServicesClient) GetServicePropertiesResponder

func (client FileServicesClient) GetServicePropertiesResponder(resp *http.Response) (result FileServiceProperties, err error)

GetServicePropertiesResponder handles the response to the GetServiceProperties request. The method always closes the http.Response Body.

func (FileServicesClient) GetServicePropertiesSender

func (client FileServicesClient) GetServicePropertiesSender(req *http.Request) (*http.Response, error)

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

func (FileServicesClient) List

func (client FileServicesClient) List(ctx context.Context, resourceGroupName string, accountName string) (result FileServiceItems, err error)

List list all file services in storage accounts 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 (FileServicesClient) ListPreparer

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

ListPreparer prepares the List request.

func (FileServicesClient) ListResponder

func (client FileServicesClient) ListResponder(resp *http.Response) (result FileServiceItems, err error)

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

func (FileServicesClient) ListSender

func (client FileServicesClient) 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 (FileServicesClient) SetServiceProperties

func (client FileServicesClient) SetServiceProperties(ctx context.Context, resourceGroupName string, accountName string, parameters FileServiceProperties) (result FileServiceProperties, err error)

SetServiceProperties sets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules. 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 properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.

func (FileServicesClient) SetServicePropertiesPreparer

func (client FileServicesClient) SetServicePropertiesPreparer(ctx context.Context, resourceGroupName string, accountName string, parameters FileServiceProperties) (*http.Request, error)

SetServicePropertiesPreparer prepares the SetServiceProperties request.

func (FileServicesClient) SetServicePropertiesResponder

func (client FileServicesClient) SetServicePropertiesResponder(resp *http.Response) (result FileServiceProperties, err error)

SetServicePropertiesResponder handles the response to the SetServiceProperties request. The method always closes the http.Response Body.

func (FileServicesClient) SetServicePropertiesSender

func (client FileServicesClient) SetServicePropertiesSender(req *http.Request) (*http.Response, error)

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

type FileShare

type FileShare struct {
	autorest.Response `json:"-"`
	// FileShareProperties - Properties of the file share.
	*FileShareProperties `json:"properties,omitempty"`
	// Etag - READ-ONLY; Resource Etag.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

FileShare properties of the file share, including Id, resource name, resource type, Etag.

func (FileShare) MarshalJSON

func (fs FileShare) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for FileShare.

func (*FileShare) UnmarshalJSON

func (fs *FileShare) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for FileShare struct.

type FileShareItem

type FileShareItem struct {
	// FileShareProperties - The file share properties be listed out.
	*FileShareProperties `json:"properties,omitempty"`
	// Etag - READ-ONLY; Resource Etag.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

FileShareItem the file share properties be listed out.

func (FileShareItem) MarshalJSON

func (fsi FileShareItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for FileShareItem.

func (*FileShareItem) UnmarshalJSON

func (fsi *FileShareItem) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for FileShareItem struct.

type FileShareItems

type FileShareItems struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of file shares returned.
	Value *[]FileShareItem `json:"value,omitempty"`
	// NextLink - READ-ONLY; Request URL that can be used to query next page of shares. Returned when total number of requested shares exceed maximum page size.
	NextLink *string `json:"nextLink,omitempty"`
}

FileShareItems response schema. Contains list of shares returned, and if paging is requested or required, a URL to next page of shares.

func (FileShareItems) IsEmpty

func (fsi FileShareItems) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (FileShareItems) MarshalJSON

func (fsi FileShareItems) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for FileShareItems.

type FileShareItemsIterator

type FileShareItemsIterator struct {
	// contains filtered or unexported fields
}

FileShareItemsIterator provides access to a complete listing of FileShareItem values.

func NewFileShareItemsIterator

func NewFileShareItemsIterator(page FileShareItemsPage) FileShareItemsIterator

Creates a new instance of the FileShareItemsIterator type.

func (*FileShareItemsIterator) Next

func (iter *FileShareItemsIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*FileShareItemsIterator) NextWithContext

func (iter *FileShareItemsIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (FileShareItemsIterator) NotDone

func (iter FileShareItemsIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (FileShareItemsIterator) Response

func (iter FileShareItemsIterator) Response() FileShareItems

Response returns the raw server response from the last page request.

func (FileShareItemsIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type FileShareItemsPage

type FileShareItemsPage struct {
	// contains filtered or unexported fields
}

FileShareItemsPage contains a page of FileShareItem values.

func NewFileShareItemsPage

func NewFileShareItemsPage(cur FileShareItems, getNextPage func(context.Context, FileShareItems) (FileShareItems, error)) FileShareItemsPage

Creates a new instance of the FileShareItemsPage type.

func (*FileShareItemsPage) Next

func (page *FileShareItemsPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*FileShareItemsPage) NextWithContext

func (page *FileShareItemsPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (FileShareItemsPage) NotDone

func (page FileShareItemsPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (FileShareItemsPage) Response

func (page FileShareItemsPage) Response() FileShareItems

Response returns the raw server response from the last page request.

func (FileShareItemsPage) Values

func (page FileShareItemsPage) Values() []FileShareItem

Values returns the slice of values for the current page or nil if there are no values.

type FileShareProperties

type FileShareProperties struct {
	// LastModifiedTime - READ-ONLY; Returns the date and time the share was last modified.
	LastModifiedTime *date.Time `json:"lastModifiedTime,omitempty"`
	// Metadata - A name-value pair to associate with the share as metadata.
	Metadata map[string]*string `json:"metadata"`
	// ShareQuota - The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120).
	ShareQuota *int32 `json:"shareQuota,omitempty"`
}

FileShareProperties the properties of the file share.

func (FileShareProperties) MarshalJSON

func (fsp FileShareProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for FileShareProperties.

type FileSharesClient

type FileSharesClient struct {
	BaseClient
}

FileSharesClient is the the Azure Storage Management API.

func NewFileSharesClient

func NewFileSharesClient(subscriptionID string) FileSharesClient

NewFileSharesClient creates an instance of the FileSharesClient client.

func NewFileSharesClientWithBaseURI

func NewFileSharesClientWithBaseURI(baseURI string, subscriptionID string) FileSharesClient

NewFileSharesClientWithBaseURI creates an instance of the FileSharesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (FileSharesClient) Create

func (client FileSharesClient) Create(ctx context.Context, resourceGroupName string, accountName string, shareName string, fileShare FileShare) (result FileShare, err error)

Create creates a new share under the specified account as described by request body. The share resource includes metadata and properties for that share. It does not include a list of the files contained by the share. 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. shareName - the name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. fileShare - properties of the file share to create.

func (FileSharesClient) CreatePreparer

func (client FileSharesClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, shareName string, fileShare FileShare) (*http.Request, error)

CreatePreparer prepares the Create request.

func (FileSharesClient) CreateResponder

func (client FileSharesClient) CreateResponder(resp *http.Response) (result FileShare, err error)

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

func (FileSharesClient) CreateSender

func (client FileSharesClient) 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 (FileSharesClient) Delete

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

Delete deletes specified share under its 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. shareName - the name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.

func (FileSharesClient) DeletePreparer

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

DeletePreparer prepares the Delete request.

func (FileSharesClient) DeleteResponder

func (client FileSharesClient) 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 (FileSharesClient) DeleteSender

func (client FileSharesClient) 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 (FileSharesClient) Get

func (client FileSharesClient) Get(ctx context.Context, resourceGroupName string, accountName string, shareName string) (result FileShare, err error)

Get gets properties of a specified share. 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. shareName - the name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.

func (FileSharesClient) GetPreparer

func (client FileSharesClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, shareName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (FileSharesClient) GetResponder

func (client FileSharesClient) GetResponder(resp *http.Response) (result FileShare, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (FileSharesClient) GetSender

func (client FileSharesClient) GetSender(req *http.Request) (*http.Response, error)

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

func (FileSharesClient) List

func (client FileSharesClient) List(ctx context.Context, resourceGroupName string, accountName string, skipToken string, maxpagesize string, filter string) (result FileShareItemsPage, err error)

List lists all shares. 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. skipToken - optional. Continuation token for the list operation. maxpagesize - optional. Specified maximum number of shares that can be included in the list. filter - optional. When specified, only share names starting with the filter will be listed.

func (FileSharesClient) ListComplete

func (client FileSharesClient) ListComplete(ctx context.Context, resourceGroupName string, accountName string, skipToken string, maxpagesize string, filter string) (result FileShareItemsIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (FileSharesClient) ListPreparer

func (client FileSharesClient) ListPreparer(ctx context.Context, resourceGroupName string, accountName string, skipToken string, maxpagesize string, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (FileSharesClient) ListResponder

func (client FileSharesClient) ListResponder(resp *http.Response) (result FileShareItems, err error)

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

func (FileSharesClient) ListSender

func (client FileSharesClient) 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 (FileSharesClient) Update

func (client FileSharesClient) Update(ctx context.Context, resourceGroupName string, accountName string, shareName string, fileShare FileShare) (result FileShare, err error)

Update updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist. 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. shareName - the name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. fileShare - properties to update for the file share.

func (FileSharesClient) UpdatePreparer

func (client FileSharesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, shareName string, fileShare FileShare) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (FileSharesClient) UpdateResponder

func (client FileSharesClient) UpdateResponder(resp *http.Response) (result FileShare, err error)

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

func (FileSharesClient) UpdateSender

func (client FileSharesClient) 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 GeoReplicationStats

type GeoReplicationStats struct {
	// Status - READ-ONLY; The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. Possible values include: 'GeoReplicationStatusLive', 'GeoReplicationStatusBootstrap', 'GeoReplicationStatusUnavailable'
	Status GeoReplicationStatus `json:"status,omitempty"`
	// LastSyncTime - READ-ONLY; All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap.
	LastSyncTime *date.Time `json:"lastSyncTime,omitempty"`
	// CanFailover - READ-ONLY; A boolean flag which indicates whether or not account failover is supported for the account.
	CanFailover *bool `json:"canFailover,omitempty"`
}

GeoReplicationStats statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account.

func (GeoReplicationStats) MarshalJSON

func (grs GeoReplicationStats) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GeoReplicationStats.

type GeoReplicationStatus

type GeoReplicationStatus string

GeoReplicationStatus enumerates the values for geo replication status.

const (
	// GeoReplicationStatusBootstrap ...
	GeoReplicationStatusBootstrap GeoReplicationStatus = "Bootstrap"
	// GeoReplicationStatusLive ...
	GeoReplicationStatusLive GeoReplicationStatus = "Live"
	// GeoReplicationStatusUnavailable ...
	GeoReplicationStatusUnavailable GeoReplicationStatus = "Unavailable"
)

func PossibleGeoReplicationStatusValues

func PossibleGeoReplicationStatusValues() []GeoReplicationStatus

PossibleGeoReplicationStatusValues returns an array of possible values for the GeoReplicationStatus const type.

type HTTPProtocol

type HTTPProtocol string

HTTPProtocol enumerates the values for http protocol.

const (
	// HTTPS ...
	HTTPS HTTPProtocol = "https"
	// Httpshttp ...
	Httpshttp HTTPProtocol = "https,http"
)

func PossibleHTTPProtocolValues

func PossibleHTTPProtocolValues() []HTTPProtocol

PossibleHTTPProtocolValues returns an array of possible values for the HTTPProtocol const type.

type IPRule

type IPRule struct {
	// IPAddressOrRange - Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.
	IPAddressOrRange *string `json:"value,omitempty"`
	// Action - The action of IP ACL rule. Possible values include: 'Allow'
	Action Action `json:"action,omitempty"`
}

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

type Identity

type Identity struct {
	// PrincipalID - READ-ONLY; The principal ID of resource identity.
	PrincipalID *string `json:"principalId,omitempty"`
	// TenantID - READ-ONLY; The tenant ID of resource.
	TenantID *string `json:"tenantId,omitempty"`
	// Type - The identity type.
	Type *string `json:"type,omitempty"`
}

Identity identity for the resource.

func (Identity) MarshalJSON

func (i Identity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Identity.

type ImmutabilityPolicy

type ImmutabilityPolicy struct {
	autorest.Response `json:"-"`
	// ImmutabilityPolicyProperty - The properties of an ImmutabilityPolicy of a blob container.
	*ImmutabilityPolicyProperty `json:"properties,omitempty"`
	// Etag - READ-ONLY; Resource Etag.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

ImmutabilityPolicy the ImmutabilityPolicy property of a blob container, including Id, resource name, resource type, Etag.

func (ImmutabilityPolicy) MarshalJSON

func (IP ImmutabilityPolicy) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ImmutabilityPolicy.

func (*ImmutabilityPolicy) UnmarshalJSON

func (IP *ImmutabilityPolicy) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ImmutabilityPolicy struct.

type ImmutabilityPolicyProperties

type ImmutabilityPolicyProperties struct {
	// ImmutabilityPolicyProperty - The properties of an ImmutabilityPolicy of a blob container.
	*ImmutabilityPolicyProperty `json:"properties,omitempty"`
	// Etag - READ-ONLY; ImmutabilityPolicy Etag.
	Etag *string `json:"etag,omitempty"`
	// UpdateHistory - READ-ONLY; The ImmutabilityPolicy update history of the blob container.
	UpdateHistory *[]UpdateHistoryProperty `json:"updateHistory,omitempty"`
}

ImmutabilityPolicyProperties the properties of an ImmutabilityPolicy of a blob container.

func (ImmutabilityPolicyProperties) MarshalJSON

func (ipp ImmutabilityPolicyProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ImmutabilityPolicyProperties.

func (*ImmutabilityPolicyProperties) UnmarshalJSON

func (ipp *ImmutabilityPolicyProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ImmutabilityPolicyProperties struct.

type ImmutabilityPolicyProperty

type ImmutabilityPolicyProperty struct {
	// ImmutabilityPeriodSinceCreationInDays - The immutability period for the blobs in the container since the policy creation, in days.
	ImmutabilityPeriodSinceCreationInDays *int32 `json:"immutabilityPeriodSinceCreationInDays,omitempty"`
	// State - READ-ONLY; The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. Possible values include: 'Locked', 'Unlocked'
	State ImmutabilityPolicyState `json:"state,omitempty"`
}

ImmutabilityPolicyProperty the properties of an ImmutabilityPolicy of a blob container.

func (ImmutabilityPolicyProperty) MarshalJSON

func (ipp ImmutabilityPolicyProperty) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ImmutabilityPolicyProperty.

type ImmutabilityPolicyState

type ImmutabilityPolicyState string

ImmutabilityPolicyState enumerates the values for immutability policy state.

const (
	// Locked ...
	Locked ImmutabilityPolicyState = "Locked"
	// Unlocked ...
	Unlocked ImmutabilityPolicyState = "Unlocked"
)

func PossibleImmutabilityPolicyStateValues

func PossibleImmutabilityPolicyStateValues() []ImmutabilityPolicyState

PossibleImmutabilityPolicyStateValues returns an array of possible values for the ImmutabilityPolicyState const type.

type ImmutabilityPolicyUpdateType

type ImmutabilityPolicyUpdateType string

ImmutabilityPolicyUpdateType enumerates the values for immutability policy update type.

const (
	// Extend ...
	Extend ImmutabilityPolicyUpdateType = "extend"
	// Lock ...
	Lock ImmutabilityPolicyUpdateType = "lock"
	// Put ...
	Put ImmutabilityPolicyUpdateType = "put"
)

func PossibleImmutabilityPolicyUpdateTypeValues

func PossibleImmutabilityPolicyUpdateTypeValues() []ImmutabilityPolicyUpdateType

PossibleImmutabilityPolicyUpdateTypeValues returns an array of possible values for the ImmutabilityPolicyUpdateType const type.

type KeyPermission

type KeyPermission string

KeyPermission enumerates the values for key permission.

const (
	// Full ...
	Full KeyPermission = "Full"
	// Read ...
	Read KeyPermission = "Read"
)

func PossibleKeyPermissionValues

func PossibleKeyPermissionValues() []KeyPermission

PossibleKeyPermissionValues returns an array of possible values for the KeyPermission const type.

type KeySource

type KeySource string

KeySource enumerates the values for key source.

const (
	// MicrosoftKeyvault ...
	MicrosoftKeyvault KeySource = "Microsoft.Keyvault"
	// MicrosoftStorage ...
	MicrosoftStorage KeySource = "Microsoft.Storage"
)

func PossibleKeySourceValues

func PossibleKeySourceValues() []KeySource

PossibleKeySourceValues returns an array of possible values for the KeySource const type.

type KeyVaultProperties

type KeyVaultProperties struct {
	// KeyName - The name of KeyVault key.
	KeyName *string `json:"keyname,omitempty"`
	// KeyVersion - The version of KeyVault key.
	KeyVersion *string `json:"keyversion,omitempty"`
	// KeyVaultURI - The Uri of KeyVault.
	KeyVaultURI *string `json:"keyvaulturi,omitempty"`
}

KeyVaultProperties properties of key vault.

type Kind

type Kind string

Kind enumerates the values for kind.

const (
	// BlobStorage ...
	BlobStorage Kind = "BlobStorage"
	// BlockBlobStorage ...
	BlockBlobStorage Kind = "BlockBlobStorage"
	// FileStorage ...
	FileStorage Kind = "FileStorage"
	// Storage ...
	Storage Kind = "Storage"
	// StorageV2 ...
	StorageV2 Kind = "StorageV2"
)

func PossibleKindValues

func PossibleKindValues() []Kind

PossibleKindValues returns an array of possible values for the Kind const type.

type LargeFileSharesState

type LargeFileSharesState string

LargeFileSharesState enumerates the values for large file shares state.

const (
	// Disabled ...
	Disabled LargeFileSharesState = "Disabled"
	// Enabled ...
	Enabled LargeFileSharesState = "Enabled"
)

func PossibleLargeFileSharesStateValues

func PossibleLargeFileSharesStateValues() []LargeFileSharesState

PossibleLargeFileSharesStateValues returns an array of possible values for the LargeFileSharesState const type.

type LeaseContainerRequest

type LeaseContainerRequest struct {
	// Action - Specifies the lease action. Can be one of the available actions. Possible values include: 'Acquire', 'Renew', 'Change', 'Release', 'Break'
	Action Action1 `json:"action,omitempty"`
	// LeaseID - Identifies the lease. Can be specified in any valid GUID string format.
	LeaseID *string `json:"leaseId,omitempty"`
	// BreakPeriod - Optional. For a break action, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60.
	BreakPeriod *int32 `json:"breakPeriod,omitempty"`
	// LeaseDuration - Required for acquire. Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires.
	LeaseDuration *int32 `json:"leaseDuration,omitempty"`
	// ProposedLeaseID - Optional for acquire, required for change. Proposed lease ID, in a GUID string format.
	ProposedLeaseID *string `json:"proposedLeaseId,omitempty"`
}

LeaseContainerRequest lease Container request schema.

type LeaseContainerResponse

type LeaseContainerResponse struct {
	autorest.Response `json:"-"`
	// LeaseID - Returned unique lease ID that must be included with any request to delete the container, or to renew, change, or release the lease.
	LeaseID *string `json:"leaseId,omitempty"`
	// LeaseTimeSeconds - Approximate time remaining in the lease period, in seconds.
	LeaseTimeSeconds *string `json:"leaseTimeSeconds,omitempty"`
}

LeaseContainerResponse lease Container response schema.

type LeaseDuration

type LeaseDuration string

LeaseDuration enumerates the values for lease duration.

const (
	// Fixed ...
	Fixed LeaseDuration = "Fixed"
	// Infinite ...
	Infinite LeaseDuration = "Infinite"
)

func PossibleLeaseDurationValues

func PossibleLeaseDurationValues() []LeaseDuration

PossibleLeaseDurationValues returns an array of possible values for the LeaseDuration const type.

type LeaseState

type LeaseState string

LeaseState enumerates the values for lease state.

const (
	// LeaseStateAvailable ...
	LeaseStateAvailable LeaseState = "Available"
	// LeaseStateBreaking ...
	LeaseStateBreaking LeaseState = "Breaking"
	// LeaseStateBroken ...
	LeaseStateBroken LeaseState = "Broken"
	// LeaseStateExpired ...
	LeaseStateExpired LeaseState = "Expired"
	// LeaseStateLeased ...
	LeaseStateLeased LeaseState = "Leased"
)

func PossibleLeaseStateValues

func PossibleLeaseStateValues() []LeaseState

PossibleLeaseStateValues returns an array of possible values for the LeaseState const type.

type LeaseStatus

type LeaseStatus string

LeaseStatus enumerates the values for lease status.

const (
	// LeaseStatusLocked ...
	LeaseStatusLocked LeaseStatus = "Locked"
	// LeaseStatusUnlocked ...
	LeaseStatusUnlocked LeaseStatus = "Unlocked"
)

func PossibleLeaseStatusValues

func PossibleLeaseStatusValues() []LeaseStatus

PossibleLeaseStatusValues returns an array of possible values for the LeaseStatus const type.

type LegalHold

type LegalHold struct {
	autorest.Response `json:"-"`
	// HasLegalHold - READ-ONLY; The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.
	HasLegalHold *bool `json:"hasLegalHold,omitempty"`
	// Tags - Each tag should be 3 to 23 alphanumeric characters and is normalized to lower case at SRP.
	Tags *[]string `json:"tags,omitempty"`
}

LegalHold the LegalHold property of a blob container.

func (LegalHold) MarshalJSON

func (lh LegalHold) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LegalHold.

type LegalHoldProperties

type LegalHoldProperties struct {
	// HasLegalHold - READ-ONLY; The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.
	HasLegalHold *bool `json:"hasLegalHold,omitempty"`
	// Tags - The list of LegalHold tags of a blob container.
	Tags *[]TagProperty `json:"tags,omitempty"`
}

LegalHoldProperties the LegalHold property of a blob container.

func (LegalHoldProperties) MarshalJSON

func (lhp LegalHoldProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LegalHoldProperties.

type ListAccountSasResponse

type ListAccountSasResponse struct {
	autorest.Response `json:"-"`
	// AccountSasToken - READ-ONLY; List SAS credentials of storage account.
	AccountSasToken *string `json:"accountSasToken,omitempty"`
}

ListAccountSasResponse the List SAS credentials operation response.

func (ListAccountSasResponse) MarshalJSON

func (lasr ListAccountSasResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ListAccountSasResponse.

type ListContainerItem

type ListContainerItem struct {
	// ContainerProperties - The blob container properties be listed out.
	*ContainerProperties `json:"properties,omitempty"`
	// Etag - READ-ONLY; Resource Etag.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

ListContainerItem the blob container properties be listed out.

func (ListContainerItem) MarshalJSON

func (lci ListContainerItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ListContainerItem.

func (*ListContainerItem) UnmarshalJSON

func (lci *ListContainerItem) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ListContainerItem struct.

type ListContainerItems

type ListContainerItems struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of blobs containers returned.
	Value *[]ListContainerItem `json:"value,omitempty"`
	// NextLink - READ-ONLY; Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.
	NextLink *string `json:"nextLink,omitempty"`
}

ListContainerItems response schema. Contains list of blobs returned, and if paging is requested or required, a URL to next page of containers.

func (ListContainerItems) IsEmpty

func (lci ListContainerItems) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (ListContainerItems) MarshalJSON

func (lci ListContainerItems) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ListContainerItems.

type ListContainerItemsIterator

type ListContainerItemsIterator struct {
	// contains filtered or unexported fields
}

ListContainerItemsIterator provides access to a complete listing of ListContainerItem values.

func NewListContainerItemsIterator

func NewListContainerItemsIterator(page ListContainerItemsPage) ListContainerItemsIterator

Creates a new instance of the ListContainerItemsIterator type.

func (*ListContainerItemsIterator) Next

func (iter *ListContainerItemsIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ListContainerItemsIterator) NextWithContext

func (iter *ListContainerItemsIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ListContainerItemsIterator) NotDone

func (iter ListContainerItemsIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ListContainerItemsIterator) Response

Response returns the raw server response from the last page request.

func (ListContainerItemsIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ListContainerItemsPage

type ListContainerItemsPage struct {
	// contains filtered or unexported fields
}

ListContainerItemsPage contains a page of ListContainerItem values.

func NewListContainerItemsPage

func NewListContainerItemsPage(cur ListContainerItems, getNextPage func(context.Context, ListContainerItems) (ListContainerItems, error)) ListContainerItemsPage

Creates a new instance of the ListContainerItemsPage type.

func (*ListContainerItemsPage) Next

func (page *ListContainerItemsPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ListContainerItemsPage) NextWithContext

func (page *ListContainerItemsPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ListContainerItemsPage) NotDone

func (page ListContainerItemsPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ListContainerItemsPage) Response

Response returns the raw server response from the last page request.

func (ListContainerItemsPage) Values

func (page ListContainerItemsPage) Values() []ListContainerItem

Values returns the slice of values for the current page or nil if there are no values.

type ListKeyExpand

type ListKeyExpand string

ListKeyExpand enumerates the values for list key expand.

const (
	// Kerb ...
	Kerb ListKeyExpand = "kerb"
)

func PossibleListKeyExpandValues

func PossibleListKeyExpandValues() []ListKeyExpand

PossibleListKeyExpandValues returns an array of possible values for the ListKeyExpand const type.

type ListServiceSasResponse

type ListServiceSasResponse struct {
	autorest.Response `json:"-"`
	// ServiceSasToken - READ-ONLY; List service SAS credentials of specific resource.
	ServiceSasToken *string `json:"serviceSasToken,omitempty"`
}

ListServiceSasResponse the List service SAS credentials operation response.

func (ListServiceSasResponse) MarshalJSON

func (lssr ListServiceSasResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ListServiceSasResponse.

type ManagementPoliciesClient

type ManagementPoliciesClient struct {
	BaseClient
}

ManagementPoliciesClient is the the Azure Storage Management API.

func NewManagementPoliciesClient

func NewManagementPoliciesClient(subscriptionID string) ManagementPoliciesClient

NewManagementPoliciesClient creates an instance of the ManagementPoliciesClient client.

func NewManagementPoliciesClientWithBaseURI

func NewManagementPoliciesClientWithBaseURI(baseURI string, subscriptionID string) ManagementPoliciesClient

NewManagementPoliciesClientWithBaseURI creates an instance of the ManagementPoliciesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ManagementPoliciesClient) CreateOrUpdate

func (client ManagementPoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, properties ManagementPolicy) (result ManagementPolicy, err error)

CreateOrUpdate sets the managementpolicy to 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. properties - the ManagementPolicy set to a storage account.

func (ManagementPoliciesClient) CreateOrUpdatePreparer

func (client ManagementPoliciesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, properties ManagementPolicy) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ManagementPoliciesClient) CreateOrUpdateResponder

func (client ManagementPoliciesClient) CreateOrUpdateResponder(resp *http.Response) (result ManagementPolicy, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ManagementPoliciesClient) CreateOrUpdateSender

func (client ManagementPoliciesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

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

func (ManagementPoliciesClient) Delete

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

Delete deletes the managementpolicy associated with 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 (ManagementPoliciesClient) DeletePreparer

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

DeletePreparer prepares the Delete request.

func (ManagementPoliciesClient) DeleteResponder

func (client ManagementPoliciesClient) 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 (ManagementPoliciesClient) DeleteSender

func (client ManagementPoliciesClient) 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 (ManagementPoliciesClient) Get

func (client ManagementPoliciesClient) Get(ctx context.Context, resourceGroupName string, accountName string) (result ManagementPolicy, err error)

Get gets the managementpolicy associated with 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 (ManagementPoliciesClient) GetPreparer

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

GetPreparer prepares the Get request.

func (ManagementPoliciesClient) GetResponder

func (client ManagementPoliciesClient) GetResponder(resp *http.Response) (result ManagementPolicy, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ManagementPoliciesClient) GetSender

func (client ManagementPoliciesClient) GetSender(req *http.Request) (*http.Response, error)

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

type ManagementPolicy

type ManagementPolicy struct {
	autorest.Response `json:"-"`
	// ManagementPolicyProperties - Returns the Storage Account Data Policies Rules.
	*ManagementPolicyProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

ManagementPolicy the Get Storage Account ManagementPolicies operation response.

func (ManagementPolicy) MarshalJSON

func (mp ManagementPolicy) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ManagementPolicy.

func (*ManagementPolicy) UnmarshalJSON

func (mp *ManagementPolicy) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ManagementPolicy struct.

type ManagementPolicyAction

type ManagementPolicyAction struct {
	// BaseBlob - The management policy action for base blob
	BaseBlob *ManagementPolicyBaseBlob `json:"baseBlob,omitempty"`
	// Snapshot - The management policy action for snapshot
	Snapshot *ManagementPolicySnapShot `json:"snapshot,omitempty"`
}

ManagementPolicyAction actions are applied to the filtered blobs when the execution condition is met.

type ManagementPolicyBaseBlob

type ManagementPolicyBaseBlob struct {
	// TierToCool - The function to tier blobs to cool storage. Support blobs currently at Hot tier
	TierToCool *DateAfterModification `json:"tierToCool,omitempty"`
	// TierToArchive - The function to tier blobs to archive storage. Support blobs currently at Hot or Cool tier
	TierToArchive *DateAfterModification `json:"tierToArchive,omitempty"`
	// Delete - The function to delete the blob
	Delete *DateAfterModification `json:"delete,omitempty"`
}

ManagementPolicyBaseBlob management policy action for base blob.

type ManagementPolicyDefinition

type ManagementPolicyDefinition struct {
	// Actions - An object that defines the action set.
	Actions *ManagementPolicyAction `json:"actions,omitempty"`
	// Filters - An object that defines the filter set.
	Filters *ManagementPolicyFilter `json:"filters,omitempty"`
}

ManagementPolicyDefinition an object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set.

type ManagementPolicyFilter

type ManagementPolicyFilter struct {
	// PrefixMatch - An array of strings for prefixes to be match.
	PrefixMatch *[]string `json:"prefixMatch,omitempty"`
	// BlobTypes - An array of predefined enum values. Only blockBlob is supported.
	BlobTypes *[]string `json:"blobTypes,omitempty"`
}

ManagementPolicyFilter filters limit rule actions to a subset of blobs within the storage account. If multiple filters are defined, a logical AND is performed on all filters.

type ManagementPolicyProperties

type ManagementPolicyProperties struct {
	// LastModifiedTime - READ-ONLY; Returns the date and time the ManagementPolicies was last modified.
	LastModifiedTime *date.Time `json:"lastModifiedTime,omitempty"`
	// Policy - The Storage Account ManagementPolicy, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.
	Policy *ManagementPolicySchema `json:"policy,omitempty"`
}

ManagementPolicyProperties the Storage Account ManagementPolicy properties.

func (ManagementPolicyProperties) MarshalJSON

func (mpp ManagementPolicyProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ManagementPolicyProperties.

type ManagementPolicyRule

type ManagementPolicyRule struct {
	// Enabled - Rule is enabled if set to true.
	Enabled *bool `json:"enabled,omitempty"`
	// Name - A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy.
	Name *string `json:"name,omitempty"`
	// Type - The valid value is Lifecycle
	Type *string `json:"type,omitempty"`
	// Definition - An object that defines the Lifecycle rule.
	Definition *ManagementPolicyDefinition `json:"definition,omitempty"`
}

ManagementPolicyRule an object that wraps the Lifecycle rule. Each rule is uniquely defined by name.

type ManagementPolicySchema

type ManagementPolicySchema struct {
	// Rules - The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.
	Rules *[]ManagementPolicyRule `json:"rules,omitempty"`
}

ManagementPolicySchema the Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.

type ManagementPolicySnapShot

type ManagementPolicySnapShot struct {
	// Delete - The function to delete the blob snapshot
	Delete *DateAfterCreation `json:"delete,omitempty"`
}

ManagementPolicySnapShot management policy action for snapshot.

type MetricSpecification

type MetricSpecification struct {
	// Name - Name of metric specification.
	Name *string `json:"name,omitempty"`
	// DisplayName - Display name of metric specification.
	DisplayName *string `json:"displayName,omitempty"`
	// DisplayDescription - Display description of metric specification.
	DisplayDescription *string `json:"displayDescription,omitempty"`
	// Unit - Unit could be Bytes or Count.
	Unit *string `json:"unit,omitempty"`
	// Dimensions - Dimensions of blobs, including blob type and access tier.
	Dimensions *[]Dimension `json:"dimensions,omitempty"`
	// AggregationType - Aggregation type could be Average.
	AggregationType *string `json:"aggregationType,omitempty"`
	// FillGapWithZero - The property to decide fill gap with zero or not.
	FillGapWithZero *bool `json:"fillGapWithZero,omitempty"`
	// Category - The category this metric specification belong to, could be Capacity.
	Category *string `json:"category,omitempty"`
	// ResourceIDDimensionNameOverride - Account Resource Id.
	ResourceIDDimensionNameOverride *string `json:"resourceIdDimensionNameOverride,omitempty"`
}

MetricSpecification metric specification of operation.

type MinimumTLSVersion

type MinimumTLSVersion string

MinimumTLSVersion enumerates the values for minimum tls version.

const (
	// TLS10 ...
	TLS10 MinimumTLSVersion = "TLS1_0"
	// TLS11 ...
	TLS11 MinimumTLSVersion = "TLS1_1"
	// TLS12 ...
	TLS12 MinimumTLSVersion = "TLS1_2"
)

func PossibleMinimumTLSVersionValues

func PossibleMinimumTLSVersionValues() []MinimumTLSVersion

PossibleMinimumTLSVersionValues returns an array of possible values for the MinimumTLSVersion const type.

type NetworkRuleSet

type NetworkRuleSet struct {
	// Bypass - Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, "Logging, Metrics"), or None to bypass none of those traffics. Possible values include: 'None', 'Logging', 'Metrics', 'AzureServices'
	Bypass Bypass `json:"bypass,omitempty"`
	// VirtualNetworkRules - Sets the virtual network rules
	VirtualNetworkRules *[]VirtualNetworkRule `json:"virtualNetworkRules,omitempty"`
	// IPRules - Sets the IP ACL rules
	IPRules *[]IPRule `json:"ipRules,omitempty"`
	// DefaultAction - Specifies the default action of allow or deny when no other rules match. Possible values include: 'DefaultActionAllow', 'DefaultActionDeny'
	DefaultAction DefaultAction `json:"defaultAction,omitempty"`
}

NetworkRuleSet network rule set

type Operation

type Operation struct {
	// Name - Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
	// Display - Display metadata associated with the operation.
	Display *OperationDisplay `json:"display,omitempty"`
	// Origin - The origin of operations.
	Origin *string `json:"origin,omitempty"`
	// OperationProperties - Properties of operation, include metric specifications.
	*OperationProperties `json:"properties,omitempty"`
}

Operation storage REST API operation definition.

func (Operation) MarshalJSON

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Operation.

func (*Operation) UnmarshalJSON

func (o *Operation) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Operation struct.

type OperationDisplay

type OperationDisplay struct {
	// Provider - Service provider: Microsoft Storage.
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource on which the operation is performed etc.
	Resource *string `json:"resource,omitempty"`
	// Operation - Type of operation: get, read, delete, etc.
	Operation *string `json:"operation,omitempty"`
	// Description - Description of the operation.
	Description *string `json:"description,omitempty"`
}

OperationDisplay display metadata associated with the operation.

type OperationListResult

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - List of Storage operations supported by the Storage resource provider.
	Value *[]Operation `json:"value,omitempty"`
}

OperationListResult 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 - One property of operation, include metric specifications.
	ServiceSpecification *ServiceSpecification `json:"serviceSpecification,omitempty"`
}

OperationProperties properties of operation, include metric specifications.

type OperationsClient

type OperationsClient struct {
	BaseClient
}

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List

func (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)

List lists all of the available Storage Rest API operations.

func (OperationsClient) ListPreparer

func (client OperationsClient) ListPreparer(ctx context.Context) (*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 ...
	A Permissions = "a"
	// C ...
	C Permissions = "c"
	// D ...
	D Permissions = "d"
	// L ...
	L Permissions = "l"
	// P ...
	P Permissions = "p"
	// R ...
	R Permissions = "r"
	// U ...
	U Permissions = "u"
	// W ...
	W Permissions = "w"
)

func PossiblePermissionsValues

func PossiblePermissionsValues() []Permissions

PossiblePermissionsValues returns an array of possible values for the Permissions const type.

type ProvisioningState

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

func PossibleProvisioningStateValues() []ProvisioningState

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

type ProxyResource

type ProxyResource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

ProxyResource the resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

func (ProxyResource) MarshalJSON

func (pr ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProxyResource.

type PublicAccess

type PublicAccess string

PublicAccess enumerates the values for public access.

const (
	// PublicAccessBlob ...
	PublicAccessBlob PublicAccess = "Blob"
	// PublicAccessContainer ...
	PublicAccessContainer PublicAccess = "Container"
	// PublicAccessNone ...
	PublicAccessNone PublicAccess = "None"
)

func PossiblePublicAccessValues

func PossiblePublicAccessValues() []PublicAccess

PossiblePublicAccessValues returns an array of possible values for the PublicAccess const type.

type Reason

type Reason string

Reason enumerates the values for reason.

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

func PossibleReasonValues

func PossibleReasonValues() []Reason

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

type ReasonCode

type ReasonCode string

ReasonCode enumerates the values for reason code.

const (
	// NotAvailableForSubscription ...
	NotAvailableForSubscription ReasonCode = "NotAvailableForSubscription"
	// QuotaID ...
	QuotaID ReasonCode = "QuotaId"
)

func PossibleReasonCodeValues

func PossibleReasonCodeValues() []ReasonCode

PossibleReasonCodeValues returns an array of possible values for the ReasonCode const type.

type Resource

type Resource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Resource common fields that are returned in the response for all Azure Resource Manager resources

func (Resource) MarshalJSON

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

MarshalJSON is the custom marshaler for Resource.

type Restriction

type Restriction struct {
	// Type - READ-ONLY; The type of restrictions. As of now only possible value for this is location.
	Type *string `json:"type,omitempty"`
	// Values - READ-ONLY; The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.
	Values *[]string `json:"values,omitempty"`
	// ReasonCode - The reason for the restriction. As of now this can be "QuotaId" or "NotAvailableForSubscription". Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The "NotAvailableForSubscription" is related to capacity at DC. Possible values include: 'QuotaID', 'NotAvailableForSubscription'
	ReasonCode ReasonCode `json:"reasonCode,omitempty"`
}

Restriction the restriction because of which SKU cannot be used.

func (Restriction) MarshalJSON

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

MarshalJSON is the custom marshaler for Restriction.

type SKUCapability

type SKUCapability struct {
	// Name - READ-ONLY; The name of capability, The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc.
	Name *string `json:"name,omitempty"`
	// Value - READ-ONLY; A string value to indicate states of given capability. Possibly 'true' or 'false'.
	Value *string `json:"value,omitempty"`
}

SKUCapability the capability information in the specified SKU, including file encryption, network ACLs, change notification, etc.

func (SKUCapability) MarshalJSON

func (sc SKUCapability) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SKUCapability.

type ServiceSasParameters

type ServiceSasParameters struct {
	// CanonicalizedResource - The canonical path to the signed resource.
	CanonicalizedResource *string `json:"canonicalizedResource,omitempty"`
	// Resource - The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s). Possible values include: 'SignedResourceB', 'SignedResourceC', 'SignedResourceF', 'SignedResourceS'
	Resource SignedResource `json:"signedResource,omitempty"`
	// Permissions - The signed permissions for the service SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). Possible values include: 'R', 'D', 'W', 'L', 'A', 'C', 'U', 'P'
	Permissions Permissions `json:"signedPermission,omitempty"`
	// IPAddressOrRange - An IP address or a range of IP addresses from which to accept requests.
	IPAddressOrRange *string `json:"signedIp,omitempty"`
	// Protocols - The protocol permitted for a request made with the account SAS. Possible values include: 'Httpshttp', 'HTTPS'
	Protocols HTTPProtocol `json:"signedProtocol,omitempty"`
	// SharedAccessStartTime - The time at which the SAS becomes valid.
	SharedAccessStartTime *date.Time `json:"signedStart,omitempty"`
	// SharedAccessExpiryTime - The time at which the shared access signature becomes invalid.
	SharedAccessExpiryTime *date.Time `json:"signedExpiry,omitempty"`
	// Identifier - A unique value up to 64 characters in length that correlates to an access policy specified for the container, queue, or table.
	Identifier *string `json:"signedIdentifier,omitempty"`
	// PartitionKeyStart - The start of partition key.
	PartitionKeyStart *string `json:"startPk,omitempty"`
	// PartitionKeyEnd - The end of partition key.
	PartitionKeyEnd *string `json:"endPk,omitempty"`
	// RowKeyStart - The start of row key.
	RowKeyStart *string `json:"startRk,omitempty"`
	// RowKeyEnd - The end of row key.
	RowKeyEnd *string `json:"endRk,omitempty"`
	// KeyToSign - The key to sign the account SAS token with.
	KeyToSign *string `json:"keyToSign,omitempty"`
	// CacheControl - The response header override for cache control.
	CacheControl *string `json:"rscc,omitempty"`
	// ContentDisposition - The response header override for content disposition.
	ContentDisposition *string `json:"rscd,omitempty"`
	// ContentEncoding - The response header override for content encoding.
	ContentEncoding *string `json:"rsce,omitempty"`
	// ContentLanguage - The response header override for content language.
	ContentLanguage *string `json:"rscl,omitempty"`
	// ContentType - The response header override for content type.
	ContentType *string `json:"rsct,omitempty"`
}

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

type ServiceSpecification

type ServiceSpecification struct {
	// MetricSpecifications - Metric specifications of operation.
	MetricSpecifications *[]MetricSpecification `json:"metricSpecifications,omitempty"`
}

ServiceSpecification one property of operation, include metric specifications.

type Services

type Services string

Services enumerates the values for services.

const (
	// B ...
	B Services = "b"
	// F ...
	F Services = "f"
	// Q ...
	Q Services = "q"
	// T ...
	T Services = "t"
)

func PossibleServicesValues

func PossibleServicesValues() []Services

PossibleServicesValues returns an array of possible values for the Services const type.

type SignedResource

type SignedResource string

SignedResource enumerates the values for signed resource.

const (
	// SignedResourceB ...
	SignedResourceB SignedResource = "b"
	// SignedResourceC ...
	SignedResourceC SignedResource = "c"
	// SignedResourceF ...
	SignedResourceF SignedResource = "f"
	// SignedResourceS ...
	SignedResourceS SignedResource = "s"
)

func PossibleSignedResourceValues

func PossibleSignedResourceValues() []SignedResource

PossibleSignedResourceValues returns an array of possible values for the SignedResource const type.

type SignedResourceTypes

type SignedResourceTypes string

SignedResourceTypes enumerates the values for signed resource types.

const (
	// SignedResourceTypesC ...
	SignedResourceTypesC SignedResourceTypes = "c"
	// SignedResourceTypesO ...
	SignedResourceTypesO SignedResourceTypes = "o"
	// SignedResourceTypesS ...
	SignedResourceTypesS SignedResourceTypes = "s"
)

func PossibleSignedResourceTypesValues

func PossibleSignedResourceTypesValues() []SignedResourceTypes

PossibleSignedResourceTypesValues returns an array of possible values for the SignedResourceTypes const type.

type Sku

type Sku struct {
	// Name - Gets or sets the SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. Possible values include: 'StandardLRS', 'StandardGRS', 'StandardRAGRS', 'StandardZRS', 'PremiumLRS', 'PremiumZRS', 'StandardGZRS', 'StandardRAGZRS'
	Name SkuName `json:"name,omitempty"`
	// Tier - READ-ONLY; Gets the SKU tier. This is based on the SKU name. Possible values include: 'Standard', 'Premium'
	Tier SkuTier `json:"tier,omitempty"`
	// ResourceType - READ-ONLY; The type of the resource, usually it is 'storageAccounts'.
	ResourceType *string `json:"resourceType,omitempty"`
	// Kind - READ-ONLY; Indicates the type of storage account. Possible values include: 'Storage', 'StorageV2', 'BlobStorage', 'FileStorage', 'BlockBlobStorage'
	Kind Kind `json:"kind,omitempty"`
	// Locations - READ-ONLY; The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.).
	Locations *[]string `json:"locations,omitempty"`
	// Capabilities - READ-ONLY; The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc.
	Capabilities *[]SKUCapability `json:"capabilities,omitempty"`
	// Restrictions - The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.
	Restrictions *[]Restriction `json:"restrictions,omitempty"`
}

Sku the SKU of the storage account.

func (Sku) MarshalJSON

func (s Sku) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Sku.

type SkuListResult

type SkuListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; Get the list result of storage SKUs and their properties.
	Value *[]Sku `json:"value,omitempty"`
}

SkuListResult the response from the List Storage SKUs operation.

func (SkuListResult) MarshalJSON

func (slr SkuListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SkuListResult.

type SkuName

type SkuName string

SkuName enumerates the values for sku name.

const (
	// PremiumLRS ...
	PremiumLRS SkuName = "Premium_LRS"
	// PremiumZRS ...
	PremiumZRS SkuName = "Premium_ZRS"
	// StandardGRS ...
	StandardGRS SkuName = "Standard_GRS"
	// StandardGZRS ...
	StandardGZRS SkuName = "Standard_GZRS"
	// StandardLRS ...
	StandardLRS SkuName = "Standard_LRS"
	// StandardRAGRS ...
	StandardRAGRS SkuName = "Standard_RAGRS"
	// StandardRAGZRS ...
	StandardRAGZRS SkuName = "Standard_RAGZRS"
	// StandardZRS ...
	StandardZRS SkuName = "Standard_ZRS"
)

func PossibleSkuNameValues

func PossibleSkuNameValues() []SkuName

PossibleSkuNameValues returns an array of possible values for the SkuName const type.

type SkuTier

type SkuTier string

SkuTier enumerates the values for sku tier.

const (
	// Premium ...
	Premium SkuTier = "Premium"
	// Standard ...
	Standard SkuTier = "Standard"
)

func PossibleSkuTierValues

func PossibleSkuTierValues() []SkuTier

PossibleSkuTierValues returns an array of possible values for the SkuTier const type.

type SkusClient

type SkusClient struct {
	BaseClient
}

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (SkusClient) List

func (client SkusClient) List(ctx context.Context) (result SkuListResult, err error)

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

func (SkusClient) ListPreparer

func (client SkusClient) ListPreparer(ctx context.Context) (*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 ...
	StateDeprovisioning State = "deprovisioning"
	// StateFailed ...
	StateFailed State = "failed"
	// StateNetworkSourceDeleted ...
	StateNetworkSourceDeleted State = "networkSourceDeleted"
	// StateProvisioning ...
	StateProvisioning State = "provisioning"
	// StateSucceeded ...
	StateSucceeded State = "succeeded"
)

func PossibleStateValues

func PossibleStateValues() []State

PossibleStateValues returns an array of possible values for the State const type.

type TagProperty

type TagProperty struct {
	// Tag - READ-ONLY; The tag value.
	Tag *string `json:"tag,omitempty"`
	// Timestamp - READ-ONLY; Returns the date and time the tag was added.
	Timestamp *date.Time `json:"timestamp,omitempty"`
	// ObjectIdentifier - READ-ONLY; Returns the Object ID of the user who added the tag.
	ObjectIdentifier *string `json:"objectIdentifier,omitempty"`
	// TenantID - READ-ONLY; Returns the Tenant ID that issued the token for the user who added the tag.
	TenantID *string `json:"tenantId,omitempty"`
	// Upn - READ-ONLY; Returns the User Principal Name of the user who added the tag.
	Upn *string `json:"upn,omitempty"`
}

TagProperty a tag of the LegalHold of a blob container.

func (TagProperty) MarshalJSON

func (tp TagProperty) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TagProperty.

type TrackedResource

type TrackedResource struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

type UpdateHistoryProperty

type UpdateHistoryProperty struct {
	// Update - READ-ONLY; The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. Possible values include: 'Put', 'Lock', 'Extend'
	Update ImmutabilityPolicyUpdateType `json:"update,omitempty"`
	// ImmutabilityPeriodSinceCreationInDays - READ-ONLY; The immutability period for the blobs in the container since the policy creation, in days.
	ImmutabilityPeriodSinceCreationInDays *int32 `json:"immutabilityPeriodSinceCreationInDays,omitempty"`
	// Timestamp - READ-ONLY; Returns the date and time the ImmutabilityPolicy was updated.
	Timestamp *date.Time `json:"timestamp,omitempty"`
	// ObjectIdentifier - READ-ONLY; Returns the Object ID of the user who updated the ImmutabilityPolicy.
	ObjectIdentifier *string `json:"objectIdentifier,omitempty"`
	// TenantID - READ-ONLY; Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy.
	TenantID *string `json:"tenantId,omitempty"`
	// Upn - READ-ONLY; Returns the User Principal Name of the user who updated the ImmutabilityPolicy.
	Upn *string `json:"upn,omitempty"`
}

UpdateHistoryProperty an update history of the ImmutabilityPolicy of a blob container.

func (UpdateHistoryProperty) MarshalJSON

func (uhp UpdateHistoryProperty) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UpdateHistoryProperty.

type Usage

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

Usage describes Storage Resource Usage.

func (Usage) MarshalJSON

func (u Usage) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Usage.

type UsageListResult

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

UsageListResult the response from the List Usages operation.

type UsageName

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

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

func (UsageName) MarshalJSON

func (un UsageName) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UsageName.

type UsageUnit

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

func PossibleUsageUnitValues() []UsageUnit

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

type UsagesClient

type UsagesClient struct {
	BaseClient
}

UsagesClient is the the Azure Storage Management API.

func NewUsagesClient

func NewUsagesClient(subscriptionID string) UsagesClient

NewUsagesClient creates an instance of the UsagesClient client.

func NewUsagesClientWithBaseURI

func NewUsagesClientWithBaseURI(baseURI string, subscriptionID string) UsagesClient

NewUsagesClientWithBaseURI creates an instance of the UsagesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (UsagesClient) ListByLocation

func (client UsagesClient) ListByLocation(ctx context.Context, location string) (result UsageListResult, err error)

ListByLocation gets the current usage count and the limit for the resources of the location under the subscription. Parameters: location - the location of the Azure Storage resource.

func (UsagesClient) ListByLocationPreparer

func (client UsagesClient) ListByLocationPreparer(ctx context.Context, location string) (*http.Request, error)

ListByLocationPreparer prepares the ListByLocation request.

func (UsagesClient) ListByLocationResponder

func (client UsagesClient) ListByLocationResponder(resp *http.Response) (result UsageListResult, err error)

ListByLocationResponder handles the response to the ListByLocation request. The method always closes the http.Response Body.

func (UsagesClient) ListByLocationSender

func (client UsagesClient) ListByLocationSender(req *http.Request) (*http.Response, error)

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

type VirtualNetworkRule

type VirtualNetworkRule struct {
	// VirtualNetworkResourceID - Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.
	VirtualNetworkResourceID *string `json:"id,omitempty"`
	// Action - The action of virtual network rule. Possible values include: 'Allow'
	Action Action `json:"action,omitempty"`
	// State - Gets the state of virtual network rule. Possible values include: 'StateProvisioning', 'StateDeprovisioning', 'StateSucceeded', 'StateFailed', 'StateNetworkSourceDeleted'
	State State `json:"state,omitempty"`
}

VirtualNetworkRule virtual Network rule.

Directories

Path Synopsis
Deprecated: Please note, this package has been deprecated.
Deprecated: Please note, this package has been deprecated.

Jump to

Keyboard shortcuts

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