Documentation ¶
Overview ¶
Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.
Package storage implements the Azure ARM Storage service API version 2017-10-01.
The Azure Storage Management API.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type AccessTier
- type Account
- type AccountCheckNameAvailabilityParameters
- type AccountCreateParameters
- type AccountKey
- type AccountListKeysResult
- type AccountListResult
- type AccountProperties
- type AccountPropertiesCreateParameters
- type AccountPropertiesUpdateParameters
- type AccountRegenerateKeyParameters
- type AccountSasParameters
- type AccountStatus
- type AccountUpdateParameters
- type AccountsClient
- func (client AccountsClient) CheckNameAvailability(ctx context.Context, accountName AccountCheckNameAvailabilityParameters) (result CheckNameAvailabilityResult, err error)
- func (client AccountsClient) CheckNameAvailabilityPreparer(ctx context.Context, accountName AccountCheckNameAvailabilityParameters) (*http.Request, error)
- func (client AccountsClient) CheckNameAvailabilityResponder(resp *http.Response) (result CheckNameAvailabilityResult, err error)
- func (client AccountsClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) Create(ctx context.Context, resourceGroupName string, accountName string, ...) (result AccountsCreateFuture, err error)
- func (client AccountsClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client AccountsClient) CreateResponder(resp *http.Response) (result Account, err error)
- func (client AccountsClient) CreateSender(req *http.Request) (future AccountsCreateFuture, err error)
- func (client AccountsClient) Delete(ctx context.Context, resourceGroupName string, accountName string) (result autorest.Response, err error)
- func (client AccountsClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
- func (client AccountsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client AccountsClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) GetProperties(ctx context.Context, resourceGroupName string, accountName string) (result Account, err error)
- func (client AccountsClient) GetPropertiesPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
- func (client AccountsClient) GetPropertiesResponder(resp *http.Response) (result Account, err error)
- func (client AccountsClient) GetPropertiesSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) List(ctx context.Context) (result AccountListResult, err error)
- func (client AccountsClient) ListAccountSAS(ctx context.Context, resourceGroupName string, accountName string, ...) (result ListAccountSasResponse, err error)
- func (client AccountsClient) ListAccountSASPreparer(ctx context.Context, resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client AccountsClient) ListAccountSASResponder(resp *http.Response) (result ListAccountSasResponse, err error)
- func (client AccountsClient) ListAccountSASSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result AccountListResult, err error)
- func (client AccountsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
- func (client AccountsClient) ListByResourceGroupResponder(resp *http.Response) (result AccountListResult, err error)
- func (client AccountsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) ListKeys(ctx context.Context, resourceGroupName string, accountName string) (result AccountListKeysResult, err error)
- func (client AccountsClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
- func (client AccountsClient) ListKeysResponder(resp *http.Response) (result AccountListKeysResult, err error)
- func (client AccountsClient) ListKeysSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client AccountsClient) ListResponder(resp *http.Response) (result AccountListResult, err error)
- func (client AccountsClient) ListSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) ListServiceSAS(ctx context.Context, resourceGroupName string, accountName string, ...) (result ListServiceSasResponse, err error)
- func (client AccountsClient) ListServiceSASPreparer(ctx context.Context, resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client AccountsClient) ListServiceSASResponder(resp *http.Response) (result ListServiceSasResponse, err error)
- func (client AccountsClient) ListServiceSASSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) RegenerateKey(ctx context.Context, resourceGroupName string, accountName string, ...) (result AccountListKeysResult, err error)
- func (client AccountsClient) RegenerateKeyPreparer(ctx context.Context, resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client AccountsClient) RegenerateKeyResponder(resp *http.Response) (result AccountListKeysResult, err error)
- func (client AccountsClient) RegenerateKeySender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) Update(ctx context.Context, resourceGroupName string, accountName string, ...) (result Account, err error)
- func (client AccountsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client AccountsClient) UpdateResponder(resp *http.Response) (result Account, err error)
- func (client AccountsClient) UpdateSender(req *http.Request) (*http.Response, error)
- type AccountsCreateFuture
- type Action
- type BaseClient
- type Bypass
- type CheckNameAvailabilityResult
- type CustomDomain
- type DefaultAction
- type Dimension
- type Encryption
- type EncryptionService
- type EncryptionServices
- type Endpoints
- type HTTPProtocol
- type IPRule
- type Identity
- type KeyPermission
- type KeySource
- type KeyVaultProperties
- type Kind
- type ListAccountSasResponse
- type ListServiceSasResponse
- type MetricSpecification
- type NetworkRuleSet
- type Operation
- type OperationDisplay
- type OperationListResult
- type OperationProperties
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type Permissions
- type ProvisioningState
- type Reason
- type ReasonCode
- type Resource
- type Restriction
- type SKUCapability
- type ServiceSasParameters
- type ServiceSpecification
- type Services
- type SignedResource
- type SignedResourceTypes
- type Sku
- type SkuListResult
- type SkuName
- type SkuTier
- type SkusClient
- func (client SkusClient) List(ctx context.Context) (result SkuListResult, err error)
- func (client SkusClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client SkusClient) ListResponder(resp *http.Response) (result SkuListResult, err error)
- func (client SkusClient) ListSender(req *http.Request) (*http.Response, error)
- type State
- type Usage
- type UsageClient
- func (client UsageClient) List(ctx context.Context) (result UsageListResult, err error)
- func (client UsageClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client UsageClient) ListResponder(resp *http.Response) (result UsageListResult, err error)
- func (client UsageClient) ListSender(req *http.Request) (*http.Response, error)
- type UsageListResult
- type UsageName
- type UsageUnit
- type VirtualNetworkRule
Constants ¶
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' Kind Kind `json:"kind,omitempty"` // Identity - The identity of the resource. Identity *Identity `json:"identity,omitempty"` // AccountProperties - Properties of the storage account. *AccountProperties `json:"properties,omitempty"` // ID - READ-ONLY; Resource Id ID *string `json:"id,omitempty"` // Name - READ-ONLY; Resource name Name *string `json:"name,omitempty"` // Type - READ-ONLY; Resource type Type *string `json:"type,omitempty"` // Location - Resource location Location *string `json:"location,omitempty"` // Tags - Tags assigned to a resource; can be used for viewing and grouping a resource (across resource groups). Tags map[string]*string `json:"tags"` }
Account the storage account.
func (Account) MarshalJSON ¶
MarshalJSON is the custom marshaler for Account.
func (*Account) UnmarshalJSON ¶
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' Kind Kind `json:"kind,omitempty"` // Location - Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed. Location *string `json:"location,omitempty"` // Tags - Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters. Tags map[string]*string `json:"tags"` // Identity - The identity of the resource. Identity *Identity `json:"identity,omitempty"` // AccountPropertiesCreateParameters - The parameters used to create the storage account. *AccountPropertiesCreateParameters `json:"properties,omitempty"` }
AccountCreateParameters the parameters used when creating a storage account.
func (AccountCreateParameters) MarshalJSON ¶
func (acp AccountCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AccountCreateParameters.
func (*AccountCreateParameters) UnmarshalJSON ¶
func (acp *AccountCreateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AccountCreateParameters struct.
type 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"` }
AccountListResult the response from the List Storage Accounts operation.
func (AccountListResult) MarshalJSON ¶
func (alr AccountListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AccountListResult.
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"` // 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"` }
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 - Provides the encryption settings on the account. If left unspecified the account encryption settings will remain the same. The default setting is unencrypted. 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"` // EnableHTTPSTrafficOnly - Allows https traffic only to storage service if sets to true. EnableHTTPSTrafficOnly *bool `json:"supportsHttpsTrafficOnly,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"` // 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"` }
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. 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 *date.Time `json:"signedStart,omitempty"` 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 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 or Premium_LRS, 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' 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 ¶
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 ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (AccountsClient) GetProperties ¶
func (client AccountsClient) GetProperties(ctx context.Context, resourceGroupName string, accountName string) (result Account, err error)
GetProperties returns the properties for the specified storage account including but not limited to name, SKU name, location, and account status. The ListKeys operation should be used to retrieve storage keys. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive. accountName - the name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
func (AccountsClient) GetPropertiesPreparer ¶
func (client AccountsClient) GetPropertiesPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
GetPropertiesPreparer prepares the GetProperties request.
func (AccountsClient) GetPropertiesResponder ¶
func (client AccountsClient) GetPropertiesResponder(resp *http.Response) (result Account, err error)
GetPropertiesResponder handles the response to the GetProperties request. The method always closes the http.Response Body.
func (AccountsClient) GetPropertiesSender ¶
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 AccountListResult, err error)
List lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.
func (AccountsClient) ListAccountSAS ¶
func (client AccountsClient) ListAccountSAS(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 ¶
ListAccountSASSender sends the ListAccountSAS request. The method will close the http.Response Body if it receives an error.
func (AccountsClient) ListByResourceGroup ¶
func (client AccountsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result AccountListResult, err error)
ListByResourceGroup lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive.
func (AccountsClient) ListByResourceGroupPreparer ¶
func (client AccountsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (AccountsClient) ListByResourceGroupResponder ¶
func (client AccountsClient) ListByResourceGroupResponder(resp *http.Response) (result AccountListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (AccountsClient) ListByResourceGroupSender ¶
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (AccountsClient) ListKeys ¶
func (client AccountsClient) ListKeys(ctx context.Context, resourceGroupName string, accountName string) (result AccountListKeysResult, err error)
ListKeys lists the access keys for the specified storage account. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive. accountName - the name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
func (AccountsClient) ListKeysPreparer ¶
func (client AccountsClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListKeysPreparer prepares the ListKeys request.
func (AccountsClient) ListKeysResponder ¶
func (client AccountsClient) ListKeysResponder(resp *http.Response) (result AccountListKeysResult, err error)
ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.
func (AccountsClient) ListKeysSender ¶
ListKeysSender sends the ListKeys request. The method will close the http.Response Body if it receives an error.
func (AccountsClient) ListPreparer ¶
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 ¶
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 ¶
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 for the specified storage account. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive. accountName - the name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. regenerateKey - specifies name of the key which should be regenerated -- key1 or key2.
func (AccountsClient) RegenerateKeyPreparer ¶
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 ¶
RegenerateKeySender sends the RegenerateKey request. The method will close the http.Response Body if it receives an error.
func (AccountsClient) Update ¶
func (client AccountsClient) Update(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 ¶
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 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 BaseClient ¶
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 Bypass ¶
type Bypass string
Bypass enumerates the values for bypass.
func PossibleBypassValues ¶
func PossibleBypassValues() []Bypass
PossibleBypassValues returns an array of possible values for the Bypass const type.
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 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 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 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 Encryption ¶
type Encryption struct { // Services - List of services which support encryption. Services *EncryptionServices `json:"services,omitempty"` // KeySource - The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault. Possible values include: 'MicrosoftStorage', 'MicrosoftKeyvault' KeySource KeySource `json:"keySource,omitempty"` // KeyVaultProperties - Properties provided by key vault. KeyVaultProperties *KeyVaultProperties `json:"keyvaultproperties,omitempty"` }
Encryption the encryption settings on the storage account.
type EncryptionService ¶
type EncryptionService struct { // Enabled - A boolean indicating whether or not the service encrypts the data as it is stored. Enabled *bool `json:"enabled,omitempty"` // LastEnabledTime - READ-ONLY; Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. LastEnabledTime *date.Time `json:"lastEnabledTime,omitempty"` }
EncryptionService a service that allows server-side encryption to be used.
func (EncryptionService) MarshalJSON ¶
func (es EncryptionService) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EncryptionService.
type EncryptionServices ¶
type EncryptionServices struct { // Blob - The encryption function of the blob storage service. Blob *EncryptionService `json:"blob,omitempty"` // File - The encryption function of the file storage service. File *EncryptionService `json:"file,omitempty"` // Table - READ-ONLY; The encryption function of the table storage service. Table *EncryptionService `json:"table,omitempty"` // Queue - READ-ONLY; The encryption function of the queue storage service. Queue *EncryptionService `json:"queue,omitempty"` }
EncryptionServices a list of services that support encryption.
func (EncryptionServices) MarshalJSON ¶
func (es EncryptionServices) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EncryptionServices.
type Endpoints ¶
type Endpoints struct { // Blob - READ-ONLY; Gets the blob endpoint. Blob *string `json:"blob,omitempty"` // Queue - READ-ONLY; Gets the queue endpoint. Queue *string `json:"queue,omitempty"` // Table - READ-ONLY; Gets the table endpoint. Table *string `json:"table,omitempty"` // File - READ-ONLY; Gets the file endpoint. File *string `json:"file,omitempty"` }
Endpoints the URIs that are used to perform a retrieval of a public blob, queue, or table object.
func (Endpoints) MarshalJSON ¶
MarshalJSON is the custom marshaler for Endpoints.
type HTTPProtocol ¶
type HTTPProtocol string
HTTPProtocol enumerates the values for http protocol.
const ( // HTTPS ... HTTPS HTTPProtocol = "https" // Httpshttp ... Httpshttp HTTPProtocol = "https,http" )
func PossibleHTTPProtocolValues ¶
func PossibleHTTPProtocolValues() []HTTPProtocol
PossibleHTTPProtocolValues returns an array of possible values for the HTTPProtocol const type.
type IPRule ¶
type IPRule struct { // IPAddressOrRange - Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. IPAddressOrRange *string `json:"value,omitempty"` // Action - The action of IP ACL rule. Possible values include: 'Allow' Action Action `json:"action,omitempty"` }
IPRule IP rule with specific IP or IP range in CIDR format.
type Identity ¶
type Identity struct { // PrincipalID - READ-ONLY; The principal ID of resource identity. PrincipalID *string `json:"principalId,omitempty"` // TenantID - READ-ONLY; The tenant ID of resource. TenantID *string `json:"tenantId,omitempty"` // Type - The identity type. Type *string `json:"type,omitempty"` }
Identity identity for the resource.
func (Identity) MarshalJSON ¶
MarshalJSON is the custom marshaler for Identity.
type KeyPermission ¶
type KeyPermission string
KeyPermission enumerates the values for key permission.
const ( // Full ... Full KeyPermission = "Full" // Read ... Read KeyPermission = "Read" )
func PossibleKeyPermissionValues ¶
func PossibleKeyPermissionValues() []KeyPermission
PossibleKeyPermissionValues returns an array of possible values for the KeyPermission const type.
type KeySource ¶
type KeySource string
KeySource enumerates the values for key source.
func PossibleKeySourceValues ¶
func PossibleKeySourceValues() []KeySource
PossibleKeySourceValues returns an array of possible values for the KeySource const type.
type KeyVaultProperties ¶
type KeyVaultProperties struct { // KeyName - The name of KeyVault key. KeyName *string `json:"keyname,omitempty"` // KeyVersion - The version of KeyVault key. KeyVersion *string `json:"keyversion,omitempty"` // KeyVaultURI - The Uri of KeyVault. KeyVaultURI *string `json:"keyvaulturi,omitempty"` }
KeyVaultProperties properties of key vault.
type Kind ¶
type Kind string
Kind enumerates the values for kind.
func PossibleKindValues ¶
func PossibleKindValues() []Kind
PossibleKindValues returns an array of possible values for the Kind const type.
type ListAccountSasResponse ¶
type ListAccountSasResponse struct { autorest.Response `json:"-"` // AccountSasToken - READ-ONLY; List SAS credentials of storage account. AccountSasToken *string `json:"accountSasToken,omitempty"` }
ListAccountSasResponse the List SAS credentials operation response.
func (ListAccountSasResponse) MarshalJSON ¶
func (lasr ListAccountSasResponse) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ListAccountSasResponse.
type ListServiceSasResponse ¶
type ListServiceSasResponse struct { autorest.Response `json:"-"` // ServiceSasToken - READ-ONLY; List service SAS credentials of specific resource. ServiceSasToken *string `json:"serviceSasToken,omitempty"` }
ListServiceSasResponse the List service SAS credentials operation response.
func (ListServiceSasResponse) MarshalJSON ¶
func (lssr ListServiceSasResponse) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ListServiceSasResponse.
type MetricSpecification ¶
type MetricSpecification struct { // Name - Name of metric specification. Name *string `json:"name,omitempty"` // DisplayName - Display name of metric specification. DisplayName *string `json:"displayName,omitempty"` // DisplayDescription - Display description of metric specification. DisplayDescription *string `json:"displayDescription,omitempty"` // Unit - Unit could be Bytes or Count. Unit *string `json:"unit,omitempty"` // Dimensions - Dimensions of blobs, including blob type and access tier. Dimensions *[]Dimension `json:"dimensions,omitempty"` // AggregationType - Aggregation type could be Average. AggregationType *string `json:"aggregationType,omitempty"` // FillGapWithZero - The property to decide fill gap with zero or not. FillGapWithZero *bool `json:"fillGapWithZero,omitempty"` // Category - The category this metric specification belong to, could be Capacity. Category *string `json:"category,omitempty"` // ResourceIDDimensionNameOverride - Account Resource Id. ResourceIDDimensionNameOverride *string `json:"resourceIdDimensionNameOverride,omitempty"` }
MetricSpecification metric specification of operation.
type NetworkRuleSet ¶
type NetworkRuleSet struct { // Bypass - Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, "Logging, Metrics"), or None to bypass none of those traffics. Possible values include: 'None', 'Logging', 'Metrics', 'AzureServices' Bypass Bypass `json:"bypass,omitempty"` // VirtualNetworkRules - Sets the virtual network rules VirtualNetworkRules *[]VirtualNetworkRule `json:"virtualNetworkRules,omitempty"` // IPRules - Sets the IP ACL rules IPRules *[]IPRule `json:"ipRules,omitempty"` // DefaultAction - Specifies the default action of allow or deny when no other rules match. Possible values include: 'DefaultActionAllow', 'DefaultActionDeny' DefaultAction DefaultAction `json:"defaultAction,omitempty"` }
NetworkRuleSet network rule set
type Operation ¶
type Operation struct { // Name - Operation name: {provider}/{resource}/{operation} Name *string `json:"name,omitempty"` // Display - Display metadata associated with the operation. Display *OperationDisplay `json:"display,omitempty"` // Origin - The origin of operations. Origin *string `json:"origin,omitempty"` // OperationProperties - Properties of operation, include metric specifications. *OperationProperties `json:"properties,omitempty"` }
Operation storage REST API operation definition.
func (Operation) MarshalJSON ¶
MarshalJSON is the custom marshaler for Operation.
func (*Operation) UnmarshalJSON ¶
UnmarshalJSON is the custom unmarshaler for Operation struct.
type OperationDisplay ¶
type OperationDisplay struct { // Provider - Service provider: Microsoft Storage. Provider *string `json:"provider,omitempty"` // Resource - Resource on which the operation is performed etc. Resource *string `json:"resource,omitempty"` // Operation - Type of operation: get, read, delete, etc. Operation *string `json:"operation,omitempty"` }
OperationDisplay display metadata associated with the operation.
type OperationListResult ¶
type OperationListResult struct { autorest.Response `json:"-"` // Value - List of Storage operations supported by the Storage resource provider. Value *[]Operation `json:"value,omitempty"` }
OperationListResult result of the request to list Storage operations. It contains a list of operations and a URL link to get the next set of results.
type OperationProperties ¶
type OperationProperties struct { // ServiceSpecification - One property of operation, include metric specifications. ServiceSpecification *ServiceSpecification `json:"serviceSpecification,omitempty"` }
OperationProperties properties of operation, include metric specifications.
type OperationsClient ¶
type OperationsClient struct {
BaseClient
}
OperationsClient is the the Azure Storage Management API.
func NewOperationsClient ¶
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI ¶
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (OperationsClient) List ¶
func (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)
List lists all of the available Storage Rest API operations.
func (OperationsClient) ListPreparer ¶
ListPreparer prepares the List request.
func (OperationsClient) ListResponder ¶
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (OperationsClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type Permissions ¶
type Permissions string
Permissions enumerates the values for permissions.
const ( // A ... A Permissions = "a" // C ... C Permissions = "c" // D ... D Permissions = "d" // L ... L Permissions = "l" // P ... P Permissions = "p" // R ... R Permissions = "r" // U ... U Permissions = "u" // W ... W Permissions = "w" )
func PossiblePermissionsValues ¶
func PossiblePermissionsValues() []Permissions
PossiblePermissionsValues returns an array of possible values for the Permissions const type.
type ProvisioningState ¶
type ProvisioningState string
ProvisioningState enumerates the values for provisioning state.
const ( // Creating ... Creating ProvisioningState = "Creating" // ResolvingDNS ... ResolvingDNS ProvisioningState = "ResolvingDNS" // Succeeded ... Succeeded ProvisioningState = "Succeeded" )
func PossibleProvisioningStateValues ¶
func PossibleProvisioningStateValues() []ProvisioningState
PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.
type Reason ¶
type Reason string
Reason enumerates the values for reason.
func PossibleReasonValues ¶
func PossibleReasonValues() []Reason
PossibleReasonValues returns an array of possible values for the Reason const type.
type ReasonCode ¶
type ReasonCode string
ReasonCode enumerates the values for reason code.
const ( // NotAvailableForSubscription ... NotAvailableForSubscription ReasonCode = "NotAvailableForSubscription" // QuotaID ... QuotaID ReasonCode = "QuotaId" )
func PossibleReasonCodeValues ¶
func PossibleReasonCodeValues() []ReasonCode
PossibleReasonCodeValues returns an array of possible values for the ReasonCode const type.
type Resource ¶
type Resource struct { // ID - READ-ONLY; Resource Id ID *string `json:"id,omitempty"` // Name - READ-ONLY; Resource name Name *string `json:"name,omitempty"` // Type - READ-ONLY; Resource type Type *string `json:"type,omitempty"` // Location - Resource location Location *string `json:"location,omitempty"` // Tags - Tags assigned to a resource; can be used for viewing and grouping a resource (across resource groups). Tags map[string]*string `json:"tags"` }
Resource describes a storage resource.
func (Resource) MarshalJSON ¶
MarshalJSON is the custom marshaler for Resource.
type Restriction ¶
type Restriction struct { // Type - READ-ONLY; The type of restrictions. As of now only possible value for this is location. Type *string `json:"type,omitempty"` // Values - READ-ONLY; The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. Values *[]string `json:"values,omitempty"` // ReasonCode - The reason for the restriction. As of now this can be "QuotaId" or "NotAvailableForSubscription". Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The "NotAvailableForSubscription" is related to capacity at DC. Possible values include: 'QuotaID', 'NotAvailableForSubscription' ReasonCode ReasonCode `json:"reasonCode,omitempty"` }
Restriction the restriction because of which SKU cannot be used.
func (Restriction) MarshalJSON ¶
func (r Restriction) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Restriction.
type SKUCapability ¶
type SKUCapability struct { // Name - READ-ONLY; The name of capability, The capability information in the specified sku, including file encryption, network acls, change notification, etc. Name *string `json:"name,omitempty"` // Value - READ-ONLY; A string value to indicate states of given capability. Possibly 'true' or 'false'. Value *string `json:"value,omitempty"` }
SKUCapability the capability information in the specified sku, including file encryption, network acls, change notification, etc.
func (SKUCapability) MarshalJSON ¶
func (sc SKUCapability) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SKUCapability.
type ServiceSasParameters ¶
type ServiceSasParameters struct { // CanonicalizedResource - The canonical path to the signed resource. CanonicalizedResource *string `json:"canonicalizedResource,omitempty"` // Resource - The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s). Possible values include: 'SignedResourceB', 'SignedResourceC', 'SignedResourceF', 'SignedResourceS' Resource SignedResource `json:"signedResource,omitempty"` // Permissions - The signed permissions for the service SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). Possible values include: 'R', 'D', 'W', 'L', 'A', 'C', 'U', 'P' Permissions Permissions `json:"signedPermission,omitempty"` // IPAddressOrRange - An IP address or a range of IP addresses from which to accept requests. IPAddressOrRange *string `json:"signedIp,omitempty"` // Protocols - The protocol permitted for a request made with the account SAS. Possible values include: 'Httpshttp', 'HTTPS' Protocols HTTPProtocol `json:"signedProtocol,omitempty"` SharedAccessStartTime *date.Time `json:"signedStart,omitempty"` SharedAccessExpiryTime *date.Time `json:"signedExpiry,omitempty"` // Identifier - A unique value up to 64 characters in length that correlates to an access policy specified for the container, queue, or table. Identifier *string `json:"signedIdentifier,omitempty"` // PartitionKeyStart - The start of partition key. PartitionKeyStart *string `json:"startPk,omitempty"` // PartitionKeyEnd - The end of partition key. PartitionKeyEnd *string `json:"endPk,omitempty"` // RowKeyStart - The start of row key. RowKeyStart *string `json:"startRk,omitempty"` // RowKeyEnd - The end of row key. RowKeyEnd *string `json:"endRk,omitempty"` // KeyToSign - The key to sign the account SAS token with. KeyToSign *string `json:"keyToSign,omitempty"` // CacheControl - The response header override for cache control. CacheControl *string `json:"rscc,omitempty"` // ContentDisposition - The response header override for content disposition. ContentDisposition *string `json:"rscd,omitempty"` // ContentEncoding - The response header override for content encoding. ContentEncoding *string `json:"rsce,omitempty"` // ContentLanguage - The response header override for content language. ContentLanguage *string `json:"rscl,omitempty"` // ContentType - The response header override for content type. ContentType *string `json:"rsct,omitempty"` }
ServiceSasParameters the parameters to list service SAS credentials of a specific resource.
type ServiceSpecification ¶
type ServiceSpecification struct { // MetricSpecifications - Metric specifications of operation. MetricSpecifications *[]MetricSpecification `json:"metricSpecifications,omitempty"` }
ServiceSpecification one property of operation, include metric specifications.
type Services ¶
type Services string
Services enumerates the values for services.
func PossibleServicesValues ¶
func PossibleServicesValues() []Services
PossibleServicesValues returns an array of possible values for the Services const type.
type SignedResource ¶
type SignedResource string
SignedResource enumerates the values for signed resource.
const ( // SignedResourceB ... SignedResourceB SignedResource = "b" // SignedResourceC ... SignedResourceC SignedResource = "c" // SignedResourceF ... SignedResourceF SignedResource = "f" // SignedResourceS ... SignedResourceS SignedResource = "s" )
func PossibleSignedResourceValues ¶
func PossibleSignedResourceValues() []SignedResource
PossibleSignedResourceValues returns an array of possible values for the SignedResource const type.
type SignedResourceTypes ¶
type SignedResourceTypes string
SignedResourceTypes enumerates the values for signed resource types.
const ( // SignedResourceTypesC ... SignedResourceTypesC SignedResourceTypes = "c" // SignedResourceTypesO ... SignedResourceTypesO SignedResourceTypes = "o" // SignedResourceTypesS ... SignedResourceTypesS SignedResourceTypes = "s" )
func PossibleSignedResourceTypesValues ¶
func PossibleSignedResourceTypesValues() []SignedResourceTypes
PossibleSignedResourceTypesValues returns an array of possible values for the SignedResourceTypes const type.
type Sku ¶
type Sku struct { // Name - Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. Possible values include: 'StandardLRS', 'StandardGRS', 'StandardRAGRS', 'StandardZRS', 'PremiumLRS' Name SkuName `json:"name,omitempty"` // Tier - READ-ONLY; Gets the sku tier. This is based on the SKU name. Possible values include: 'Standard', 'Premium' Tier SkuTier `json:"tier,omitempty"` // ResourceType - READ-ONLY; The type of the resource, usually it is 'storageAccounts'. ResourceType *string `json:"resourceType,omitempty"` // Kind - READ-ONLY; Indicates the type of storage account. Possible values include: 'Storage', 'StorageV2', 'BlobStorage' Kind Kind `json:"kind,omitempty"` // Locations - READ-ONLY; The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). Locations *[]string `json:"locations,omitempty"` // Capabilities - READ-ONLY; The capability information in the specified sku, including file encryption, network acls, change notification, etc. Capabilities *[]SKUCapability `json:"capabilities,omitempty"` // Restrictions - The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. Restrictions *[]Restriction `json:"restrictions,omitempty"` }
Sku the SKU of the storage account.
func (Sku) MarshalJSON ¶
MarshalJSON is the custom marshaler for Sku.
type SkuListResult ¶
type SkuListResult struct { autorest.Response `json:"-"` // Value - READ-ONLY; Get the list result of storage SKUs and their properties. Value *[]Sku `json:"value,omitempty"` }
SkuListResult the response from the List Storage SKUs operation.
func (SkuListResult) MarshalJSON ¶
func (slr SkuListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SkuListResult.
type SkuName ¶
type SkuName string
SkuName enumerates the values for sku name.
func PossibleSkuNameValues ¶
func PossibleSkuNameValues() []SkuName
PossibleSkuNameValues returns an array of possible values for the SkuName const type.
type SkuTier ¶
type SkuTier string
SkuTier enumerates the values for sku tier.
func PossibleSkuTierValues ¶
func PossibleSkuTierValues() []SkuTier
PossibleSkuTierValues returns an array of possible values for the SkuTier const type.
type SkusClient ¶
type SkusClient struct {
BaseClient
}
SkusClient is the the Azure Storage Management API.
func NewSkusClient ¶
func NewSkusClient(subscriptionID string) SkusClient
NewSkusClient creates an instance of the SkusClient client.
func NewSkusClientWithBaseURI ¶
func NewSkusClientWithBaseURI(baseURI string, subscriptionID string) SkusClient
NewSkusClientWithBaseURI creates an instance of the SkusClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (SkusClient) List ¶
func (client SkusClient) List(ctx context.Context) (result SkuListResult, err error)
List lists the available SKUs supported by Microsoft.Storage for given subscription.
func (SkusClient) ListPreparer ¶
ListPreparer prepares the List request.
func (SkusClient) ListResponder ¶
func (client SkusClient) ListResponder(resp *http.Response) (result SkuListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (SkusClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type State ¶
type State string
State enumerates the values for state.
const ( // StateDeprovisioning ... StateDeprovisioning State = "deprovisioning" // StateFailed ... StateFailed State = "failed" // StateNetworkSourceDeleted ... StateNetworkSourceDeleted State = "networkSourceDeleted" // StateProvisioning ... StateProvisioning State = "provisioning" // StateSucceeded ... StateSucceeded State = "succeeded" )
func PossibleStateValues ¶
func PossibleStateValues() []State
PossibleStateValues returns an array of possible values for the State const type.
type Usage ¶
type Usage struct { // Unit - READ-ONLY; Gets the unit of measurement. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountsPerSecond', 'BytesPerSecond' Unit UsageUnit `json:"unit,omitempty"` // CurrentValue - READ-ONLY; Gets the current count of the allocated resources in the subscription. CurrentValue *int32 `json:"currentValue,omitempty"` // Limit - READ-ONLY; Gets the maximum count of the resources that can be allocated in the subscription. Limit *int32 `json:"limit,omitempty"` // Name - READ-ONLY; Gets the name of the type of usage. Name *UsageName `json:"name,omitempty"` }
Usage describes Storage Resource Usage.
func (Usage) MarshalJSON ¶
MarshalJSON is the custom marshaler for Usage.
type UsageClient ¶
type UsageClient struct {
BaseClient
}
UsageClient is the the Azure Storage Management API.
func NewUsageClient ¶
func NewUsageClient(subscriptionID string) UsageClient
NewUsageClient creates an instance of the UsageClient client.
func NewUsageClientWithBaseURI ¶
func NewUsageClientWithBaseURI(baseURI string, subscriptionID string) UsageClient
NewUsageClientWithBaseURI creates an instance of the UsageClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (UsageClient) List ¶
func (client UsageClient) List(ctx context.Context) (result UsageListResult, err error)
List gets the current usage count and the limit for the resources under the subscription.
func (UsageClient) ListPreparer ¶
ListPreparer prepares the List request.
func (UsageClient) ListResponder ¶
func (client UsageClient) ListResponder(resp *http.Response) (result UsageListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (UsageClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type UsageListResult ¶
type UsageListResult struct { autorest.Response `json:"-"` // Value - Gets or sets the list of Storage Resource Usages. Value *[]Usage `json:"value,omitempty"` }
UsageListResult the response from the List Usages operation.
type UsageName ¶
type UsageName struct { // Value - READ-ONLY; Gets a string describing the resource name. Value *string `json:"value,omitempty"` // LocalizedValue - READ-ONLY; Gets a localized string describing the resource name. LocalizedValue *string `json:"localizedValue,omitempty"` }
UsageName the usage names that can be used; currently limited to StorageAccount.
func (UsageName) MarshalJSON ¶
MarshalJSON is the custom marshaler for UsageName.
type UsageUnit ¶
type UsageUnit string
UsageUnit enumerates the values for usage unit.
const ( // Bytes ... Bytes UsageUnit = "Bytes" // BytesPerSecond ... BytesPerSecond UsageUnit = "BytesPerSecond" // Count ... Count UsageUnit = "Count" // CountsPerSecond ... CountsPerSecond UsageUnit = "CountsPerSecond" // Percent ... Percent UsageUnit = "Percent" // Seconds ... Seconds UsageUnit = "Seconds" )
func PossibleUsageUnitValues ¶
func PossibleUsageUnitValues() []UsageUnit
PossibleUsageUnitValues returns an array of possible values for the UsageUnit const type.
type VirtualNetworkRule ¶
type VirtualNetworkRule struct { // VirtualNetworkResourceID - Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. VirtualNetworkResourceID *string `json:"id,omitempty"` // Action - The action of virtual network rule. Possible values include: 'Allow' Action Action `json:"action,omitempty"` // State - Gets the state of virtual network rule. Possible values include: 'StateProvisioning', 'StateDeprovisioning', 'StateSucceeded', 'StateFailed', 'StateNetworkSourceDeleted' State State `json:"state,omitempty"` }
VirtualNetworkRule virtual Network rule.
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Deprecated: Please note, this package has been deprecated.
|
Deprecated: Please note, this package has been deprecated. |