storage

package
Version: v58.3.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Oct 21, 2021 License: MIT Imports: 10 Imported by: 18

Documentation

Overview

Package storage implements the Azure ARM Storage service API version 2021-01-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"`
	// ExtendedLocation - The extendedLocation of the resource.
	ExtendedLocation *ExtendedLocation `json:"extendedLocation,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"`
	// ExtendedLocation - Optional. Set the extended location of the resource. If not set, the storage account will be created in Azure main region. Otherwise it will be created in the specified extended location
	ExtendedLocation *ExtendedLocation `json:"extendedLocation,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 (
	// AccountExpandBlobRestoreStatus ...
	AccountExpandBlobRestoreStatus AccountExpand = "blobRestoreStatus"
	// AccountExpandGeoReplicationStats ...
	AccountExpandGeoReplicationStats AccountExpand = "geoReplicationStats"
)

func PossibleAccountExpandValues

func PossibleAccountExpandValues() []AccountExpand

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

type AccountInternetEndpoints

type AccountInternetEndpoints struct {
	// Blob - READ-ONLY; Gets the blob endpoint.
	Blob *string `json:"blob,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"`
}

AccountInternetEndpoints the URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint.

func (AccountInternetEndpoints) MarshalJSON

func (aie AccountInternetEndpoints) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountInternetEndpoints.

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 deprecated

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 deprecated

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 AccountMicrosoftEndpoints

type AccountMicrosoftEndpoints 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"`
}

AccountMicrosoftEndpoints the URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint.

func (AccountMicrosoftEndpoints) MarshalJSON

func (ame AccountMicrosoftEndpoints) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountMicrosoftEndpoints.

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: 'LargeFileSharesStateDisabled', 'LargeFileSharesStateEnabled'
	LargeFileSharesState LargeFileSharesState `json:"largeFileSharesState,omitempty"`
	// PrivateEndpointConnections - READ-ONLY; List of private endpoint connection associated with the specified storage account
	PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
	// RoutingPreference - Maintains information about the network routing choice opted by the user for data transfer
	RoutingPreference *RoutingPreference `json:"routingPreference,omitempty"`
	// BlobRestoreStatus - READ-ONLY; Blob restore status
	BlobRestoreStatus *BlobRestoreStatus `json:"blobRestoreStatus,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"`
	// AllowSharedKeyAccess - Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.
	AllowSharedKeyAccess *bool `json:"allowSharedKeyAccess,omitempty"`
	// EnableNfsV3 - NFS 3.0 protocol support enabled if set to true.
	EnableNfsV3 *bool `json:"isNfsV3Enabled,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: 'LargeFileSharesStateDisabled', 'LargeFileSharesStateEnabled'
	LargeFileSharesState LargeFileSharesState `json:"largeFileSharesState,omitempty"`
	// RoutingPreference - Maintains information about the network routing choice opted by the user for data transfer
	RoutingPreference *RoutingPreference `json:"routingPreference,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"`
	// AllowSharedKeyAccess - Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.
	AllowSharedKeyAccess *bool `json:"allowSharedKeyAccess,omitempty"`
	// EnableNfsV3 - NFS 3.0 protocol support enabled if set to true.
	EnableNfsV3 *bool `json:"isNfsV3Enabled,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: 'LargeFileSharesStateDisabled', 'LargeFileSharesStateEnabled'
	LargeFileSharesState LargeFileSharesState `json:"largeFileSharesState,omitempty"`
	// RoutingPreference - Maintains information about the network routing choice opted by the user for data transfer
	RoutingPreference *RoutingPreference `json:"routingPreference,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"`
	// AllowSharedKeyAccess - Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.
	AllowSharedKeyAccess *bool `json:"allowSharedKeyAccess,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 and blobRestoreStatus.

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 AccountListResultPage, 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) ListByResourceGroupComplete

func (client AccountsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result AccountListResultIterator, err error)

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

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

func (client AccountsClient) RestoreBlobRanges(ctx context.Context, resourceGroupName string, accountName string, parameters BlobRestoreParameters) (result AccountsRestoreBlobRangesFuture, err error)

RestoreBlobRanges restore blobs in the specified blob ranges 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 restore blob ranges.

func (AccountsClient) RestoreBlobRangesPreparer

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

RestoreBlobRangesPreparer prepares the RestoreBlobRanges request.

func (AccountsClient) RestoreBlobRangesResponder

func (client AccountsClient) RestoreBlobRangesResponder(resp *http.Response) (result BlobRestoreStatus, err error)

RestoreBlobRangesResponder handles the response to the RestoreBlobRanges request. The method always closes the http.Response Body.

func (AccountsClient) RestoreBlobRangesSender

func (client AccountsClient) RestoreBlobRangesSender(req *http.Request) (future AccountsRestoreBlobRangesFuture, err error)

RestoreBlobRangesSender sends the RestoreBlobRanges 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 AccountsRestoreBlobRangesFuture

type AccountsRestoreBlobRangesFuture 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) (BlobRestoreStatus, error)
}

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

func (*AccountsRestoreBlobRangesFuture) UnmarshalJSON

func (future *AccountsRestoreBlobRangesFuture) 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, the only way is to delete the container after deleting all expired blobs inside the policy locked 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, maxpagesize string, filter string, include ListContainersInclude) (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. 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. include - optional, used to include the properties for soft deleted blob containers.

func (BlobContainersClient) ListComplete

func (client BlobContainersClient) ListComplete(ctx context.Context, resourceGroupName string, accountName string, maxpagesize string, filter string, include ListContainersInclude) (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, maxpagesize string, filter string, include ListContainersInclude) (*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 BlobInventoryPoliciesClient

type BlobInventoryPoliciesClient struct {
	BaseClient
}

BlobInventoryPoliciesClient is the the Azure Storage Management API.

func NewBlobInventoryPoliciesClient

func NewBlobInventoryPoliciesClient(subscriptionID string) BlobInventoryPoliciesClient

NewBlobInventoryPoliciesClient creates an instance of the BlobInventoryPoliciesClient client.

func NewBlobInventoryPoliciesClientWithBaseURI

func NewBlobInventoryPoliciesClientWithBaseURI(baseURI string, subscriptionID string) BlobInventoryPoliciesClient

NewBlobInventoryPoliciesClientWithBaseURI creates an instance of the BlobInventoryPoliciesClient 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 (BlobInventoryPoliciesClient) CreateOrUpdate

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

CreateOrUpdate sets the blob inventory policy 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 blob inventory policy set to a storage account.

func (BlobInventoryPoliciesClient) CreateOrUpdatePreparer

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (BlobInventoryPoliciesClient) CreateOrUpdateResponder

func (client BlobInventoryPoliciesClient) CreateOrUpdateResponder(resp *http.Response) (result BlobInventoryPolicy, err error)

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

func (BlobInventoryPoliciesClient) CreateOrUpdateSender

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

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

Delete deletes the blob inventory policy 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 (BlobInventoryPoliciesClient) DeletePreparer

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

DeletePreparer prepares the Delete request.

func (BlobInventoryPoliciesClient) DeleteResponder

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

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

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

Get gets the blob inventory policy 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 (BlobInventoryPoliciesClient) GetPreparer

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

GetPreparer prepares the Get request.

func (BlobInventoryPoliciesClient) GetResponder

func (client BlobInventoryPoliciesClient) GetResponder(resp *http.Response) (result BlobInventoryPolicy, err error)

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

func (BlobInventoryPoliciesClient) GetSender

func (client BlobInventoryPoliciesClient) 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 (BlobInventoryPoliciesClient) List

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

List gets the blob inventory policy 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 (BlobInventoryPoliciesClient) ListPreparer

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

ListPreparer prepares the List request.

func (BlobInventoryPoliciesClient) ListResponder

func (client BlobInventoryPoliciesClient) ListResponder(resp *http.Response) (result ListBlobInventoryPolicy, err error)

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

func (BlobInventoryPoliciesClient) ListSender

func (client BlobInventoryPoliciesClient) 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 BlobInventoryPolicy

type BlobInventoryPolicy struct {
	autorest.Response `json:"-"`
	// BlobInventoryPolicyProperties - Returns the storage account blob inventory policy rules.
	*BlobInventoryPolicyProperties `json:"properties,omitempty"`
	SystemData                     *SystemData `json:"systemData,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"`
}

BlobInventoryPolicy the storage account blob inventory policy.

func (BlobInventoryPolicy) MarshalJSON

func (bip BlobInventoryPolicy) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BlobInventoryPolicy.

func (*BlobInventoryPolicy) UnmarshalJSON

func (bip *BlobInventoryPolicy) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for BlobInventoryPolicy struct.

type BlobInventoryPolicyDefinition

type BlobInventoryPolicyDefinition struct {
	// Filters - An object that defines the filter set.
	Filters *BlobInventoryPolicyFilter `json:"filters,omitempty"`
}

BlobInventoryPolicyDefinition an object that defines the blob inventory rule. Each definition consists of a set of filters.

type BlobInventoryPolicyFilter

type BlobInventoryPolicyFilter struct {
	// PrefixMatch - An array of strings for blob prefixes to be matched.
	PrefixMatch *[]string `json:"prefixMatch,omitempty"`
	// BlobTypes - An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs.
	BlobTypes *[]string `json:"blobTypes,omitempty"`
	// IncludeBlobVersions - Includes blob versions in blob inventory when value set to true.
	IncludeBlobVersions *bool `json:"includeBlobVersions,omitempty"`
	// IncludeSnapshots - Includes blob snapshots in blob inventory when value set to true.
	IncludeSnapshots *bool `json:"includeSnapshots,omitempty"`
}

BlobInventoryPolicyFilter an object that defines the blob inventory rule filter conditions.

type BlobInventoryPolicyProperties

type BlobInventoryPolicyProperties struct {
	// LastModifiedTime - READ-ONLY; Returns the last modified date and time of the blob inventory policy.
	LastModifiedTime *date.Time `json:"lastModifiedTime,omitempty"`
	// Policy - The storage account blob inventory policy object. It is composed of policy rules.
	Policy *BlobInventoryPolicySchema `json:"policy,omitempty"`
}

BlobInventoryPolicyProperties the storage account blob inventory policy properties.

func (BlobInventoryPolicyProperties) MarshalJSON

func (bipp BlobInventoryPolicyProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BlobInventoryPolicyProperties.

type BlobInventoryPolicyRule

type BlobInventoryPolicyRule struct {
	// Enabled - Rule is enabled when 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"`
	// Definition - An object that defines the blob inventory policy rule.
	Definition *BlobInventoryPolicyDefinition `json:"definition,omitempty"`
}

BlobInventoryPolicyRule an object that wraps the blob inventory rule. Each rule is uniquely defined by name.

type BlobInventoryPolicySchema

type BlobInventoryPolicySchema struct {
	// Enabled - Policy is enabled if set to true.
	Enabled *bool `json:"enabled,omitempty"`
	// Destination - Container name where blob inventory files are stored. Must be pre-created.
	Destination *string `json:"destination,omitempty"`
	// Type - The valid value is Inventory
	Type *string `json:"type,omitempty"`
	// Rules - The storage account blob inventory policy rules. The rule is applied when it is enabled.
	Rules *[]BlobInventoryPolicyRule `json:"rules,omitempty"`
}

BlobInventoryPolicySchema the storage account blob inventory policy rules.

type BlobRestoreParameters

type BlobRestoreParameters struct {
	// TimeToRestore - Restore blob to the specified time.
	TimeToRestore *date.Time `json:"timeToRestore,omitempty"`
	// BlobRanges - Blob ranges to restore.
	BlobRanges *[]BlobRestoreRange `json:"blobRanges,omitempty"`
}

BlobRestoreParameters blob restore parameters

type BlobRestoreProgressStatus

type BlobRestoreProgressStatus string

BlobRestoreProgressStatus enumerates the values for blob restore progress status.

const (
	// Complete ...
	Complete BlobRestoreProgressStatus = "Complete"
	// Failed ...
	Failed BlobRestoreProgressStatus = "Failed"
	// InProgress ...
	InProgress BlobRestoreProgressStatus = "InProgress"
)

func PossibleBlobRestoreProgressStatusValues

func PossibleBlobRestoreProgressStatusValues() []BlobRestoreProgressStatus

PossibleBlobRestoreProgressStatusValues returns an array of possible values for the BlobRestoreProgressStatus const type.

type BlobRestoreRange

type BlobRestoreRange struct {
	// StartRange - Blob start range. This is inclusive. Empty means account start.
	StartRange *string `json:"startRange,omitempty"`
	// EndRange - Blob end range. This is exclusive. Empty means account end.
	EndRange *string `json:"endRange,omitempty"`
}

BlobRestoreRange blob range

type BlobRestoreStatus

type BlobRestoreStatus struct {
	autorest.Response `json:"-"`
	// Status - READ-ONLY; The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. Possible values include: 'InProgress', 'Complete', 'Failed'
	Status BlobRestoreProgressStatus `json:"status,omitempty"`
	// FailureReason - READ-ONLY; Failure reason when blob restore is failed.
	FailureReason *string `json:"failureReason,omitempty"`
	// RestoreID - READ-ONLY; Id for tracking blob restore request.
	RestoreID *string `json:"restoreId,omitempty"`
	// Parameters - READ-ONLY; Blob restore request parameters.
	Parameters *BlobRestoreParameters `json:"parameters,omitempty"`
}

BlobRestoreStatus blob restore status.

func (BlobRestoreStatus) MarshalJSON

func (brs BlobRestoreStatus) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BlobRestoreStatus.

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"`
	// Sku - READ-ONLY; Sku name and tier.
	Sku *Sku `json:"sku,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 blob soft delete.
	DeleteRetentionPolicy *DeleteRetentionPolicy `json:"deleteRetentionPolicy,omitempty"`
	// IsVersioningEnabled - Versioning is enabled if set to true.
	IsVersioningEnabled *bool `json:"isVersioningEnabled,omitempty"`
	// AutomaticSnapshotPolicyEnabled - Deprecated in favor of isVersioningEnabled property.
	AutomaticSnapshotPolicyEnabled *bool `json:"automaticSnapshotPolicyEnabled,omitempty"`
	// ChangeFeed - The blob service properties for change feed events.
	ChangeFeed *ChangeFeed `json:"changeFeed,omitempty"`
	// RestorePolicy - The blob service properties for blob restore policy.
	RestorePolicy *RestorePolicyProperties `json:"restorePolicy,omitempty"`
	// ContainerDeleteRetentionPolicy - The blob service properties for container soft delete.
	ContainerDeleteRetentionPolicy *DeleteRetentionPolicy `json:"containerDeleteRetentionPolicy,omitempty"`
	// LastAccessTimeTrackingPolicy - The blob service property to configure last access time based tracking policy.
	LastAccessTimeTrackingPolicy *LastAccessTimeTrackingPolicy `json:"lastAccessTimeTrackingPolicy,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"`
	// RetentionInDays - Indicates the duration of changeFeed retention in days. Minimum value is 1 day and maximum value is 146000 days (400 years). A null value indicates an infinite retention of the change feed.
	RetentionInDays *int32 `json:"retentionInDays,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 {
	// Version - READ-ONLY; The version of the deleted blob container.
	Version *string `json:"version,omitempty"`
	// Deleted - READ-ONLY; Indicates whether the blob container was deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// DeletedTime - READ-ONLY; Blob container deletion time.
	DeletedTime *date.Time `json:"deletedTime,omitempty"`
	// RemainingRetentionDays - READ-ONLY; Remaining retention days for soft deleted blob container.
	RemainingRetentionDays *int32 `json:"remainingRetentionDays,omitempty"`
	// DefaultEncryptionScope - Default the container to use specified encryption scope for all writes.
	DefaultEncryptionScope *string `json:"defaultEncryptionScope,omitempty"`
	// DenyEncryptionScopeOverride - Block override of encryption scope from the container default.
	DenyEncryptionScopeOverride *bool `json:"denyEncryptionScopeOverride,omitempty"`
	// 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 CreatedByType

type CreatedByType string

CreatedByType enumerates the values for created by type.

const (
	// Application ...
	Application CreatedByType = "Application"
	// Key ...
	Key CreatedByType = "Key"
	// ManagedIdentity ...
	ManagedIdentity CreatedByType = "ManagedIdentity"
	// User ...
	User CreatedByType = "User"
)

func PossibleCreatedByTypeValues

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns an array of possible values for the CreatedByType const type.

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"`
	// DaysAfterLastAccessTimeGreaterThan - Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy
	DaysAfterLastAccessTimeGreaterThan *float64 `json:"daysAfterLastAccessTimeGreaterThan,omitempty"`
}

DateAfterModification object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive.

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.
	Enabled *bool `json:"enabled,omitempty"`
	// Days - Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365.
	Days *int32 `json:"days,omitempty"`
}

DeleteRetentionPolicy the service properties for soft delete.

type DeletedAccount

type DeletedAccount struct {
	autorest.Response `json:"-"`
	// DeletedAccountProperties - Properties of the deleted account.
	*DeletedAccountProperties `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"`
}

DeletedAccount deleted storage account

func (DeletedAccount) MarshalJSON

func (da DeletedAccount) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeletedAccount.

func (*DeletedAccount) UnmarshalJSON

func (da *DeletedAccount) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DeletedAccount struct.

type DeletedAccountListResult

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

DeletedAccountListResult the response from the List Deleted Accounts operation.

func (DeletedAccountListResult) IsEmpty

func (dalr DeletedAccountListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (DeletedAccountListResult) MarshalJSON

func (dalr DeletedAccountListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeletedAccountListResult.

type DeletedAccountListResultIterator

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

DeletedAccountListResultIterator provides access to a complete listing of DeletedAccount values.

func NewDeletedAccountListResultIterator

func NewDeletedAccountListResultIterator(page DeletedAccountListResultPage) DeletedAccountListResultIterator

Creates a new instance of the DeletedAccountListResultIterator type.

func (*DeletedAccountListResultIterator) Next deprecated

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 (*DeletedAccountListResultIterator) NextWithContext

func (iter *DeletedAccountListResultIterator) 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 (DeletedAccountListResultIterator) NotDone

func (iter DeletedAccountListResultIterator) NotDone() bool

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

func (DeletedAccountListResultIterator) Response

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

func (DeletedAccountListResultIterator) Value

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

type DeletedAccountListResultPage

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

DeletedAccountListResultPage contains a page of DeletedAccount values.

func NewDeletedAccountListResultPage

Creates a new instance of the DeletedAccountListResultPage type.

func (*DeletedAccountListResultPage) Next deprecated

func (page *DeletedAccountListResultPage) 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 (*DeletedAccountListResultPage) NextWithContext

func (page *DeletedAccountListResultPage) 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 (DeletedAccountListResultPage) NotDone

func (page DeletedAccountListResultPage) NotDone() bool

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

func (DeletedAccountListResultPage) Response

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

func (DeletedAccountListResultPage) Values

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

type DeletedAccountProperties

type DeletedAccountProperties struct {
	// StorageAccountResourceID - READ-ONLY; Full resource id of the original storage account.
	StorageAccountResourceID *string `json:"storageAccountResourceId,omitempty"`
	// Location - READ-ONLY; Location of the deleted account.
	Location *string `json:"location,omitempty"`
	// RestoreReference - READ-ONLY; Can be used to attempt recovering this deleted account via PutStorageAccount API.
	RestoreReference *string `json:"restoreReference,omitempty"`
	// CreationTime - READ-ONLY; Creation time of the deleted account.
	CreationTime *string `json:"creationTime,omitempty"`
	// DeletionTime - READ-ONLY; Deletion time of the deleted account.
	DeletionTime *string `json:"deletionTime,omitempty"`
}

DeletedAccountProperties attributes of a deleted storage account.

func (DeletedAccountProperties) MarshalJSON

func (dap DeletedAccountProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeletedAccountProperties.

type DeletedAccountsClient

type DeletedAccountsClient struct {
	BaseClient
}

DeletedAccountsClient is the the Azure Storage Management API.

func NewDeletedAccountsClient

func NewDeletedAccountsClient(subscriptionID string) DeletedAccountsClient

NewDeletedAccountsClient creates an instance of the DeletedAccountsClient client.

func NewDeletedAccountsClientWithBaseURI

func NewDeletedAccountsClientWithBaseURI(baseURI string, subscriptionID string) DeletedAccountsClient

NewDeletedAccountsClientWithBaseURI creates an instance of the DeletedAccountsClient 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 (DeletedAccountsClient) Get

func (client DeletedAccountsClient) Get(ctx context.Context, deletedAccountName string, location string) (result DeletedAccount, err error)

Get get properties of specified deleted account resource. Parameters: deletedAccountName - name of the deleted storage account. location - the location of the deleted storage account.

func (DeletedAccountsClient) GetPreparer

func (client DeletedAccountsClient) GetPreparer(ctx context.Context, deletedAccountName string, location string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DeletedAccountsClient) GetResponder

func (client DeletedAccountsClient) GetResponder(resp *http.Response) (result DeletedAccount, err error)

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

func (DeletedAccountsClient) GetSender

func (client DeletedAccountsClient) 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 (DeletedAccountsClient) List

List lists deleted accounts under the subscription.

func (DeletedAccountsClient) ListComplete

func (client DeletedAccountsClient) ListComplete(ctx context.Context) (result DeletedAccountListResultIterator, err error)

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

func (DeletedAccountsClient) ListPreparer

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

ListPreparer prepares the List request.

func (DeletedAccountsClient) ListResponder

func (client DeletedAccountsClient) ListResponder(resp *http.Response) (result DeletedAccountListResult, err error)

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

func (DeletedAccountsClient) ListSender

func (client DeletedAccountsClient) 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 DeletedShare

type DeletedShare struct {
	// DeletedShareName - Required. Identify the name of the deleted share that will be restored.
	DeletedShareName *string `json:"deletedShareName,omitempty"`
	// DeletedShareVersion - Required. Identify the version of the deleted share that will be restored.
	DeletedShareVersion *string `json:"deletedShareVersion,omitempty"`
}

DeletedShare the deleted share to be restored.

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 EnabledProtocols

type EnabledProtocols string

EnabledProtocols enumerates the values for enabled protocols.

const (
	// NFS ...
	NFS EnabledProtocols = "NFS"
	// SMB ...
	SMB EnabledProtocols = "SMB"
)

func PossibleEnabledProtocolsValues

func PossibleEnabledProtocolsValues() []EnabledProtocols

PossibleEnabledProtocolsValues returns an array of possible values for the EnabledProtocols 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: 'KeySourceMicrosoftStorage', 'KeySourceMicrosoftKeyvault'
	KeySource KeySource `json:"keySource,omitempty"`
	// RequireInfrastructureEncryption - A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.
	RequireInfrastructureEncryption *bool `json:"requireInfrastructureEncryption,omitempty"`
	// KeyVaultProperties - Properties provided by key vault.
	KeyVaultProperties *KeyVaultProperties `json:"keyvaultproperties,omitempty"`
	// EncryptionIdentity - The identity to be used with service-side encryption at rest.
	EncryptionIdentity *EncryptionIdentity `json:"identity,omitempty"`
}

Encryption the encryption settings on the storage account.

type EncryptionIdentity

type EncryptionIdentity struct {
	// EncryptionUserAssignedIdentity - Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account.
	EncryptionUserAssignedIdentity *string `json:"userAssignedIdentity,omitempty"`
}

EncryptionIdentity encryption identity for the storage account.

type EncryptionScope

type EncryptionScope struct {
	autorest.Response `json:"-"`
	// EncryptionScopeProperties - Properties of the encryption scope.
	*EncryptionScopeProperties `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"`
}

EncryptionScope the Encryption Scope resource.

func (EncryptionScope) MarshalJSON

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

MarshalJSON is the custom marshaler for EncryptionScope.

func (*EncryptionScope) UnmarshalJSON

func (es *EncryptionScope) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for EncryptionScope struct.

type EncryptionScopeKeyVaultProperties

type EncryptionScopeKeyVaultProperties struct {
	// KeyURI - The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope.
	KeyURI *string `json:"keyUri,omitempty"`
	// CurrentVersionedKeyIdentifier - READ-ONLY; The object identifier of the current versioned Key Vault Key in use.
	CurrentVersionedKeyIdentifier *string `json:"currentVersionedKeyIdentifier,omitempty"`
	// LastKeyRotationTimestamp - READ-ONLY; Timestamp of last rotation of the Key Vault Key.
	LastKeyRotationTimestamp *date.Time `json:"lastKeyRotationTimestamp,omitempty"`
}

EncryptionScopeKeyVaultProperties the key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'.

func (EncryptionScopeKeyVaultProperties) MarshalJSON

func (eskvp EncryptionScopeKeyVaultProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EncryptionScopeKeyVaultProperties.

type EncryptionScopeListResult

type EncryptionScopeListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of encryption scopes requested.
	Value *[]EncryptionScope `json:"value,omitempty"`
	// NextLink - READ-ONLY; Request URL that can be used to query next page of encryption scopes. Returned when total number of requested encryption scopes exceeds the maximum page size.
	NextLink *string `json:"nextLink,omitempty"`
}

EncryptionScopeListResult list of encryption scopes requested, and if paging is required, a URL to the next page of encryption scopes.

func (EncryptionScopeListResult) IsEmpty

func (eslr EncryptionScopeListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (EncryptionScopeListResult) MarshalJSON

func (eslr EncryptionScopeListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EncryptionScopeListResult.

type EncryptionScopeListResultIterator

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

EncryptionScopeListResultIterator provides access to a complete listing of EncryptionScope values.

func NewEncryptionScopeListResultIterator

func NewEncryptionScopeListResultIterator(page EncryptionScopeListResultPage) EncryptionScopeListResultIterator

Creates a new instance of the EncryptionScopeListResultIterator type.

func (*EncryptionScopeListResultIterator) Next deprecated

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 (*EncryptionScopeListResultIterator) NextWithContext

func (iter *EncryptionScopeListResultIterator) 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 (EncryptionScopeListResultIterator) NotDone

func (iter EncryptionScopeListResultIterator) NotDone() bool

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

func (EncryptionScopeListResultIterator) Response

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

func (EncryptionScopeListResultIterator) Value

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

type EncryptionScopeListResultPage

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

EncryptionScopeListResultPage contains a page of EncryptionScope values.

func NewEncryptionScopeListResultPage

Creates a new instance of the EncryptionScopeListResultPage type.

func (*EncryptionScopeListResultPage) Next deprecated

func (page *EncryptionScopeListResultPage) 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 (*EncryptionScopeListResultPage) NextWithContext

func (page *EncryptionScopeListResultPage) 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 (EncryptionScopeListResultPage) NotDone

func (page EncryptionScopeListResultPage) NotDone() bool

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

func (EncryptionScopeListResultPage) Response

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

func (EncryptionScopeListResultPage) Values

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

type EncryptionScopeProperties

type EncryptionScopeProperties struct {
	// Source - The provider for the encryption scope. Possible values (case-insensitive):  Microsoft.Storage, Microsoft.KeyVault. Possible values include: 'MicrosoftStorage', 'MicrosoftKeyVault'
	Source EncryptionScopeSource `json:"source,omitempty"`
	// State - The state of the encryption scope. Possible values (case-insensitive):  Enabled, Disabled. Possible values include: 'Enabled', 'Disabled'
	State EncryptionScopeState `json:"state,omitempty"`
	// CreationTime - READ-ONLY; Gets the creation date and time of the encryption scope in UTC.
	CreationTime *date.Time `json:"creationTime,omitempty"`
	// LastModifiedTime - READ-ONLY; Gets the last modification date and time of the encryption scope in UTC.
	LastModifiedTime *date.Time `json:"lastModifiedTime,omitempty"`
	// KeyVaultProperties - The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'.
	KeyVaultProperties *EncryptionScopeKeyVaultProperties `json:"keyVaultProperties,omitempty"`
	// RequireInfrastructureEncryption - A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.
	RequireInfrastructureEncryption *bool `json:"requireInfrastructureEncryption,omitempty"`
}

EncryptionScopeProperties properties of the encryption scope.

func (EncryptionScopeProperties) MarshalJSON

func (esp EncryptionScopeProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EncryptionScopeProperties.

type EncryptionScopeSource

type EncryptionScopeSource string

EncryptionScopeSource enumerates the values for encryption scope source.

const (
	// MicrosoftKeyVault ...
	MicrosoftKeyVault EncryptionScopeSource = "Microsoft.KeyVault"
	// MicrosoftStorage ...
	MicrosoftStorage EncryptionScopeSource = "Microsoft.Storage"
)

func PossibleEncryptionScopeSourceValues

func PossibleEncryptionScopeSourceValues() []EncryptionScopeSource

PossibleEncryptionScopeSourceValues returns an array of possible values for the EncryptionScopeSource const type.

type EncryptionScopeState

type EncryptionScopeState string

EncryptionScopeState enumerates the values for encryption scope state.

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

func PossibleEncryptionScopeStateValues

func PossibleEncryptionScopeStateValues() []EncryptionScopeState

PossibleEncryptionScopeStateValues returns an array of possible values for the EncryptionScopeState const type.

type EncryptionScopesClient

type EncryptionScopesClient struct {
	BaseClient
}

EncryptionScopesClient is the the Azure Storage Management API.

func NewEncryptionScopesClient

func NewEncryptionScopesClient(subscriptionID string) EncryptionScopesClient

NewEncryptionScopesClient creates an instance of the EncryptionScopesClient client.

func NewEncryptionScopesClientWithBaseURI

func NewEncryptionScopesClientWithBaseURI(baseURI string, subscriptionID string) EncryptionScopesClient

NewEncryptionScopesClientWithBaseURI creates an instance of the EncryptionScopesClient 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 (EncryptionScopesClient) Get

func (client EncryptionScopesClient) Get(ctx context.Context, resourceGroupName string, accountName string, encryptionScopeName string) (result EncryptionScope, err error)

Get returns the properties for the specified encryption scope. 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. encryptionScopeName - the name of the encryption scope within the specified storage account. Encryption scope 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 (EncryptionScopesClient) GetPreparer

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

GetPreparer prepares the Get request.

func (EncryptionScopesClient) GetResponder

func (client EncryptionScopesClient) GetResponder(resp *http.Response) (result EncryptionScope, err error)

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

func (EncryptionScopesClient) GetSender

func (client EncryptionScopesClient) 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 (EncryptionScopesClient) List

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

List lists all the encryption scopes available under 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 (EncryptionScopesClient) ListComplete

func (client EncryptionScopesClient) ListComplete(ctx context.Context, resourceGroupName string, accountName string) (result EncryptionScopeListResultIterator, err error)

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

func (EncryptionScopesClient) ListPreparer

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

ListPreparer prepares the List request.

func (EncryptionScopesClient) ListResponder

func (client EncryptionScopesClient) ListResponder(resp *http.Response) (result EncryptionScopeListResult, err error)

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

func (EncryptionScopesClient) ListSender

func (client EncryptionScopesClient) 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 (EncryptionScopesClient) Patch

func (client EncryptionScopesClient) Patch(ctx context.Context, resourceGroupName string, accountName string, encryptionScopeName string, encryptionScope EncryptionScope) (result EncryptionScope, err error)

Patch update encryption scope properties as specified in the request body. Update fails if the specified encryption scope 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. encryptionScopeName - the name of the encryption scope within the specified storage account. Encryption scope 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. encryptionScope - encryption scope properties to be used for the update.

func (EncryptionScopesClient) PatchPreparer

func (client EncryptionScopesClient) PatchPreparer(ctx context.Context, resourceGroupName string, accountName string, encryptionScopeName string, encryptionScope EncryptionScope) (*http.Request, error)

PatchPreparer prepares the Patch request.

func (EncryptionScopesClient) PatchResponder

func (client EncryptionScopesClient) PatchResponder(resp *http.Response) (result EncryptionScope, err error)

PatchResponder handles the response to the Patch request. The method always closes the http.Response Body.

func (EncryptionScopesClient) PatchSender

func (client EncryptionScopesClient) PatchSender(req *http.Request) (*http.Response, error)

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

func (EncryptionScopesClient) Put

func (client EncryptionScopesClient) Put(ctx context.Context, resourceGroupName string, accountName string, encryptionScopeName string, encryptionScope EncryptionScope) (result EncryptionScope, err error)

Put synchronously creates or updates an encryption scope under the specified storage account. If an encryption scope is already created and a subsequent request is issued with different properties, the encryption scope properties will be updated per the specified 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. encryptionScopeName - the name of the encryption scope within the specified storage account. Encryption scope 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. encryptionScope - encryption scope properties to be used for the create or update.

func (EncryptionScopesClient) PutPreparer

func (client EncryptionScopesClient) PutPreparer(ctx context.Context, resourceGroupName string, accountName string, encryptionScopeName string, encryptionScope EncryptionScope) (*http.Request, error)

PutPreparer prepares the Put request.

func (EncryptionScopesClient) PutResponder

func (client EncryptionScopesClient) PutResponder(resp *http.Response) (result EncryptionScope, err error)

PutResponder handles the response to the Put request. The method always closes the http.Response Body.

func (EncryptionScopesClient) PutSender

func (client EncryptionScopesClient) PutSender(req *http.Request) (*http.Response, error)

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

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"`
	// KeyType - Encryption key type to be used for the encryption service. 'Account' key type implies that an account-scoped encryption key will be used. 'Service' key type implies that a default service key is used. Possible values include: 'KeyTypeService', 'KeyTypeAccount'
	KeyType KeyType `json:"keyType,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 - The encryption function of the table storage service.
	Table *EncryptionService `json:"table,omitempty"`
	// Queue - The encryption function of the queue storage service.
	Queue *EncryptionService `json:"queue,omitempty"`
}

EncryptionServices a list of services that support encryption.

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"`
	// MicrosoftEndpoints - Gets the microsoft routing storage endpoints.
	MicrosoftEndpoints *AccountMicrosoftEndpoints `json:"microsoftEndpoints,omitempty"`
	// InternetEndpoints - Gets the internet routing storage endpoints
	InternetEndpoints *AccountInternetEndpoints `json:"internetEndpoints,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 ErrorResponse

type ErrorResponse struct {
	// Error - Azure Storage Resource Provider error response body.
	Error *ErrorResponseBody `json:"error,omitempty"`
}

ErrorResponse an error response from the storage resource provider.

type ErrorResponseBody

type ErrorResponseBody 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"`
}

ErrorResponseBody error response body contract.

type ExtendedLocation

type ExtendedLocation struct {
	// Name - The name of the extended location.
	Name *string `json:"name,omitempty"`
	// Type - The type of the extended location. Possible values include: 'EdgeZone'
	Type ExtendedLocationTypes `json:"type,omitempty"`
}

ExtendedLocation the complex type of the extended location.

type ExtendedLocationTypes

type ExtendedLocationTypes string

ExtendedLocationTypes enumerates the values for extended location types.

const (
	// EdgeZone ...
	EdgeZone ExtendedLocationTypes = "EdgeZone"
)

func PossibleExtendedLocationTypesValues

func PossibleExtendedLocationTypesValues() []ExtendedLocationTypes

PossibleExtendedLocationTypesValues returns an array of possible values for the ExtendedLocationTypes const type.

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"`
	// Sku - READ-ONLY; Sku name and tier.
	Sku *Sku `json:"sku,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"`
	// ShareDeleteRetentionPolicy - The file service properties for share soft delete.
	ShareDeleteRetentionPolicy *DeleteRetentionPolicy `json:"shareDeleteRetentionPolicy,omitempty"`
	// ProtocolSettings - Protocol settings for file service
	ProtocolSettings *ProtocolSettings `json:"protocolSettings,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 deprecated

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 deprecated

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). For Large File Shares, the maximum size is 102400.
	ShareQuota *int32 `json:"shareQuota,omitempty"`
	// EnabledProtocols - The authentication protocol that is used for the file share. Can only be specified when creating a share. Possible values include: 'SMB', 'NFS'
	EnabledProtocols EnabledProtocols `json:"enabledProtocols,omitempty"`
	// RootSquash - The property is for NFS share only. The default is NoRootSquash. Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'
	RootSquash RootSquashType `json:"rootSquash,omitempty"`
	// Version - READ-ONLY; The version of the share.
	Version *string `json:"version,omitempty"`
	// Deleted - READ-ONLY; Indicates whether the share was deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// DeletedTime - READ-ONLY; The deleted time if the share was deleted.
	DeletedTime *date.Time `json:"deletedTime,omitempty"`
	// RemainingRetentionDays - READ-ONLY; Remaining retention days for share that was soft deleted.
	RemainingRetentionDays *int32 `json:"remainingRetentionDays,omitempty"`
	// AccessTier - Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Possible values include: 'ShareAccessTierTransactionOptimized', 'ShareAccessTierHot', 'ShareAccessTierCool', 'ShareAccessTierPremium'
	AccessTier ShareAccessTier `json:"accessTier,omitempty"`
	// AccessTierChangeTime - READ-ONLY; Indicates the last modification time for share access tier.
	AccessTierChangeTime *date.Time `json:"accessTierChangeTime,omitempty"`
	// AccessTierStatus - READ-ONLY; Indicates if there is a pending transition for access tier.
	AccessTierStatus *string `json:"accessTierStatus,omitempty"`
	// ShareUsageBytes - READ-ONLY; The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.
	ShareUsageBytes *int64 `json:"shareUsageBytes,omitempty"`
	// SnapshotTime - READ-ONLY; Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
	SnapshotTime *date.Time `json:"snapshotTime,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, expand PutSharesExpand) (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. expand - optional, used to create a snapshot.

func (FileSharesClient) CreatePreparer

func (client FileSharesClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, shareName string, fileShare FileShare, expand PutSharesExpand) (*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, xMsSnapshot 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. xMsSnapshot - optional, used to delete a snapshot.

func (FileSharesClient) DeletePreparer

func (client FileSharesClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, shareName string, xMsSnapshot 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, expand GetShareExpand, xMsSnapshot 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. expand - optional, used to expand the properties within share's properties. xMsSnapshot - optional, used to retrieve properties of a snapshot.

func (FileSharesClient) GetPreparer

func (client FileSharesClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, shareName string, expand GetShareExpand, xMsSnapshot 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, maxpagesize string, filter string, expand ListSharesExpand) (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. 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. expand - optional, used to expand the properties within share's properties.

func (FileSharesClient) ListComplete

func (client FileSharesClient) ListComplete(ctx context.Context, resourceGroupName string, accountName string, maxpagesize string, filter string, expand ListSharesExpand) (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, maxpagesize string, filter string, expand ListSharesExpand) (*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) Restore

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

Restore restore a file share within a valid retention days if share soft delete is enabled 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) RestorePreparer

func (client FileSharesClient) RestorePreparer(ctx context.Context, resourceGroupName string, accountName