storageapi

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.

Index

• type AccountsClientAPI
• type BlobContainersClientAPI
• type BlobInventoryPoliciesClientAPI
• type BlobServicesClientAPI
• type DeletedAccountsClientAPI
• type EncryptionScopesClientAPI
• type FileServicesClientAPI
• type FileSharesClientAPI
• type LocalUsersClientAPI
• type ManagementPoliciesClientAPI
• type ObjectReplicationPoliciesClientAPI
• type OperationsClientAPI
• type PrivateEndpointConnectionsClientAPI
• type PrivateLinkResourcesClientAPI
• type QueueClientAPI
• type QueueServicesClientAPI
• type SkusClientAPI
• type TableClientAPI
• type TableServicesClientAPI
• type UsagesClientAPI

Types

type AccountsClientAPI

type AccountsClientAPI interface {
	AbortHierarchicalNamespaceMigration(ctx context.Context, resourceGroupName string, accountName string) (result storage.AccountsAbortHierarchicalNamespaceMigrationFuture, err error)
	CheckNameAvailability(ctx context.Context, accountName storage.AccountCheckNameAvailabilityParameters) (result storage.CheckNameAvailabilityResult, err error)
	Create(ctx context.Context, resourceGroupName string, accountName string, parameters storage.AccountCreateParameters) (result storage.AccountsCreateFuture, err error)
	Delete(ctx context.Context, resourceGroupName string, accountName string) (result autorest.Response, err error)
	Failover(ctx context.Context, resourceGroupName string, accountName string) (result storage.AccountsFailoverFuture, err error)
	GetProperties(ctx context.Context, resourceGroupName string, accountName string, expand storage.AccountExpand) (result storage.Account, err error)
	HierarchicalNamespaceMigration(ctx context.Context, resourceGroupName string, accountName string, requestType string) (result storage.AccountsHierarchicalNamespaceMigrationFuture, err error)
	List(ctx context.Context) (result storage.AccountListResultPage, err error)
	ListComplete(ctx context.Context) (result storage.AccountListResultIterator, err error)
	ListAccountSAS(ctx context.Context, resourceGroupName string, accountName string, parameters storage.AccountSasParameters) (result storage.ListAccountSasResponse, err error)
	ListByResourceGroup(ctx context.Context, resourceGroupName string) (result storage.AccountListResultPage, err error)
	ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result storage.AccountListResultIterator, err error)
	ListKeys(ctx context.Context, resourceGroupName string, accountName string, expand storage.ListKeyExpand) (result storage.AccountListKeysResult, err error)
	ListServiceSAS(ctx context.Context, resourceGroupName string, accountName string, parameters storage.ServiceSasParameters) (result storage.ListServiceSasResponse, err error)
	RegenerateKey(ctx context.Context, resourceGroupName string, accountName string, regenerateKey storage.AccountRegenerateKeyParameters) (result storage.AccountListKeysResult, err error)
	RestoreBlobRanges(ctx context.Context, resourceGroupName string, accountName string, parameters storage.BlobRestoreParameters) (result storage.AccountsRestoreBlobRangesFuture, err error)
	RevokeUserDelegationKeys(ctx context.Context, resourceGroupName string, accountName string) (result autorest.Response, err error)
	Update(ctx context.Context, resourceGroupName string, accountName string, parameters storage.AccountUpdateParameters) (result storage.Account, err error)
}

AccountsClientAPI contains the set of methods on the AccountsClient type.

type BlobContainersClientAPI

type BlobContainersClientAPI interface {
	ClearLegalHold(ctx context.Context, resourceGroupName string, accountName string, containerName string, legalHold storage.LegalHold) (result storage.LegalHold, err error)
	Create(ctx context.Context, resourceGroupName string, accountName string, containerName string, blobContainer storage.BlobContainer) (result storage.BlobContainer, err error)
	CreateOrUpdateImmutabilityPolicy(ctx context.Context, resourceGroupName string, accountName string, containerName string, parameters *storage.ImmutabilityPolicy, ifMatch string) (result storage.ImmutabilityPolicy, err error)
	Delete(ctx context.Context, resourceGroupName string, accountName string, containerName string) (result autorest.Response, err error)
	DeleteImmutabilityPolicy(ctx context.Context, resourceGroupName string, accountName string, containerName string, ifMatch string) (result storage.ImmutabilityPolicy, err error)
	ExtendImmutabilityPolicy(ctx context.Context, resourceGroupName string, accountName string, containerName string, ifMatch string, parameters *storage.ImmutabilityPolicy) (result storage.ImmutabilityPolicy, err error)
	Get(ctx context.Context, resourceGroupName string, accountName string, containerName string) (result storage.BlobContainer, err error)
	GetImmutabilityPolicy(ctx context.Context, resourceGroupName string, accountName string, containerName string, ifMatch string) (result storage.ImmutabilityPolicy, err error)
	Lease(ctx context.Context, resourceGroupName string, accountName string, containerName string, parameters *storage.LeaseContainerRequest) (result storage.LeaseContainerResponse, err error)
	List(ctx context.Context, resourceGroupName string, accountName string, maxpagesize string, filter string, include storage.ListContainersInclude) (result storage.ListContainerItemsPage, err error)
	ListComplete(ctx context.Context, resourceGroupName string, accountName string, maxpagesize string, filter string, include storage.ListContainersInclude) (result storage.ListContainerItemsIterator, err error)
	LockImmutabilityPolicy(ctx context.Context, resourceGroupName string, accountName string, containerName string, ifMatch string) (result storage.ImmutabilityPolicy, err error)
	ObjectLevelWorm(ctx context.Context, resourceGroupName string, accountName string, containerName string) (result storage.BlobContainersObjectLevelWormFuture, err error)
	SetLegalHold(ctx context.Context, resourceGroupName string, accountName string, containerName string, legalHold storage.LegalHold) (result storage.LegalHold, err error)
	Update(ctx context.Context, resourceGroupName string, accountName string, containerName string, blobContainer storage.BlobContainer) (result storage.BlobContainer, err error)
}

BlobContainersClientAPI contains the set of methods on the BlobContainersClient type.

type BlobInventoryPoliciesClientAPI

type BlobInventoryPoliciesClientAPI interface {
	CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, properties storage.BlobInventoryPolicy) (result storage.BlobInventoryPolicy, err error)
	Delete(ctx context.Context, resourceGroupName string, accountName string) (result autorest.Response, err error)
	Get(ctx context.Context, resourceGroupName string, accountName string) (result storage.BlobInventoryPolicy, err error)
	List(ctx context.Context, resourceGroupName string, accountName string) (result storage.ListBlobInventoryPolicy, err error)
}

BlobInventoryPoliciesClientAPI contains the set of methods on the BlobInventoryPoliciesClient type.

type BlobServicesClientAPI

type BlobServicesClientAPI interface {
	GetServiceProperties(ctx context.Context, resourceGroupName string, accountName string) (result storage.BlobServiceProperties, err error)
	List(ctx context.Context, resourceGroupName string, accountName string) (result storage.BlobServiceItems, err error)
	SetServiceProperties(ctx context.Context, resourceGroupName string, accountName string, parameters storage.BlobServiceProperties) (result storage.BlobServiceProperties, err error)
}

BlobServicesClientAPI contains the set of methods on the BlobServicesClient type.

type DeletedAccountsClientAPI

type DeletedAccountsClientAPI interface {
	Get(ctx context.Context, deletedAccountName string, location string) (result storage.DeletedAccount, err error)
	List(ctx context.Context) (result storage.DeletedAccountListResultPage, err error)
	ListComplete(ctx context.Context) (result storage.DeletedAccountListResultIterator, err error)
}

DeletedAccountsClientAPI contains the set of methods on the DeletedAccountsClient type.

type EncryptionScopesClientAPI

type EncryptionScopesClientAPI interface {
	Get(ctx context.Context, resourceGroupName string, accountName string, encryptionScopeName string) (result storage.EncryptionScope, err error)
	List(ctx context.Context, resourceGroupName string, accountName string) (result storage.EncryptionScopeListResultPage, err error)
	ListComplete(ctx context.Context, resourceGroupName string, accountName string) (result storage.EncryptionScopeListResultIterator, err error)
	Patch(ctx context.Context, resourceGroupName string, accountName string, encryptionScopeName string, encryptionScope storage.EncryptionScope) (result storage.EncryptionScope, err error)
	Put(ctx context.Context, resourceGroupName string, accountName string, encryptionScopeName string, encryptionScope storage.EncryptionScope) (result storage.EncryptionScope, err error)
}

EncryptionScopesClientAPI contains the set of methods on the EncryptionScopesClient type.

type FileServicesClientAPI

type FileServicesClientAPI interface {
	GetServiceProperties(ctx context.Context, resourceGroupName string, accountName string) (result storage.FileServiceProperties, err error)
	List(ctx context.Context, resourceGroupName string, accountName string) (result storage.FileServiceItems, err error)
	SetServiceProperties(ctx context.Context, resourceGroupName string, accountName string, parameters storage.FileServiceProperties) (result storage.FileServiceProperties, err error)
}

FileServicesClientAPI contains the set of methods on the FileServicesClient type.

type FileSharesClientAPI

type FileSharesClientAPI interface {
	Create(ctx context.Context, resourceGroupName string, accountName string, shareName string, fileShare storage.FileShare, expand string) (result storage.FileShare, err error)
	Delete(ctx context.Context, resourceGroupName string, accountName string, shareName string, xMsSnapshot string, include string) (result autorest.Response, err error)
	Get(ctx context.Context, resourceGroupName string, accountName string, shareName string, expand string, xMsSnapshot string) (result storage.FileShare, err error)
	Lease(ctx context.Context, resourceGroupName string, accountName string, shareName string, parameters *storage.LeaseShareRequest, xMsSnapshot string) (result storage.LeaseShareResponse, err error)
	List(ctx context.Context, resourceGroupName string, accountName string, maxpagesize string, filter string, expand string) (result storage.FileShareItemsPage, err error)
	ListComplete(ctx context.Context, resourceGroupName string, accountName string, maxpagesize string, filter string, expand string) (result storage.FileShareItemsIterator, err error)
	Restore(ctx context.Context, resourceGroupName string, accountName string, shareName string, deletedShare storage.DeletedShare) (result autorest.Response, err error)
	Update(ctx context.Context, resourceGroupName string, accountName string, shareName string, fileShare storage.FileShare) (result storage.FileShare, err error)
}

FileSharesClientAPI contains the set of methods on the FileSharesClient type.

type LocalUsersClientAPI

type LocalUsersClientAPI interface {
	CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, username string, properties storage.LocalUser) (result storage.LocalUser, err error)
	Delete(ctx context.Context, resourceGroupName string, accountName string, username string) (result autorest.Response, err error)
	Get(ctx context.Context, resourceGroupName string, accountName string, username string) (result storage.LocalUser, err error)
	List(ctx context.Context, resourceGroupName string, accountName string) (result storage.LocalUsers, err error)
	ListKeys(ctx context.Context, resourceGroupName string, accountName string, username string) (result storage.LocalUserKeys, err error)
	RegeneratePassword(ctx context.Context, resourceGroupName string, accountName string, username string) (result storage.LocalUserRegeneratePasswordResult, err error)
}

LocalUsersClientAPI contains the set of methods on the LocalUsersClient type.

type ManagementPoliciesClientAPI

type ManagementPoliciesClientAPI interface {
	CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, properties storage.ManagementPolicy) (result storage.ManagementPolicy, err error)
	Delete(ctx context.Context, resourceGroupName string, accountName string) (result autorest.Response, err error)
	Get(ctx context.Context, resourceGroupName string, accountName string) (result storage.ManagementPolicy, err error)
}

ManagementPoliciesClientAPI contains the set of methods on the ManagementPoliciesClient type.

type ObjectReplicationPoliciesClientAPI

type ObjectReplicationPoliciesClientAPI interface {
	CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, objectReplicationPolicyID string, properties storage.ObjectReplicationPolicy) (result storage.ObjectReplicationPolicy, err error)
	Delete(ctx context.Context, resourceGroupName string, accountName string, objectReplicationPolicyID string) (result autorest.Response, err error)
	Get(ctx context.Context, resourceGroupName string, accountName string, objectReplicationPolicyID string) (result storage.ObjectReplicationPolicy, err error)
	List(ctx context.Context, resourceGroupName string, accountName string) (result storage.ObjectReplicationPolicies, err error)
}

ObjectReplicationPoliciesClientAPI contains the set of methods on the ObjectReplicationPoliciesClient type.

type OperationsClientAPI

type OperationsClientAPI interface {
	List(ctx context.Context) (result storage.OperationListResult, err error)
}

OperationsClientAPI contains the set of methods on the OperationsClient type.

type PrivateEndpointConnectionsClientAPI

type PrivateEndpointConnectionsClientAPI interface {
	Delete(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string) (result autorest.Response, err error)
	Get(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string) (result storage.PrivateEndpointConnection, err error)
	List(ctx context.Context, resourceGroupName string, accountName string) (result storage.PrivateEndpointConnectionListResult, err error)
	Put(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string, properties storage.PrivateEndpointConnection) (result storage.PrivateEndpointConnection, err error)
}

PrivateEndpointConnectionsClientAPI contains the set of methods on the PrivateEndpointConnectionsClient type.

type PrivateLinkResourcesClientAPI

type PrivateLinkResourcesClientAPI interface {
	ListByStorageAccount(ctx context.Context, resourceGroupName string, accountName string) (result storage.PrivateLinkResourceListResult, err error)
}

PrivateLinkResourcesClientAPI contains the set of methods on the PrivateLinkResourcesClient type.

type QueueClientAPI

type QueueClientAPI interface {
	Create(ctx context.Context, resourceGroupName string, accountName string, queueName string, queue storage.Queue) (result storage.Queue, err error)
	Delete(ctx context.Context, resourceGroupName string, accountName string, queueName string) (result autorest.Response, err error)
	Get(ctx context.Context, resourceGroupName string, accountName string, queueName string) (result storage.Queue, err error)
	List(ctx context.Context, resourceGroupName string, accountName string, maxpagesize string, filter string) (result storage.ListQueueResourcePage, err error)
	ListComplete(ctx context.Context, resourceGroupName string, accountName string, maxpagesize string, filter string) (result storage.ListQueueResourceIterator, err error)
	Update(ctx context.Context, resourceGroupName string, accountName string, queueName string, queue storage.Queue) (result storage.Queue, err error)
}

QueueClientAPI contains the set of methods on the QueueClient type.

type QueueServicesClientAPI

type QueueServicesClientAPI interface {
	GetServiceProperties(ctx context.Context, resourceGroupName string, accountName string) (result storage.QueueServiceProperties, err error)
	List(ctx context.Context, resourceGroupName string, accountName string) (result storage.ListQueueServices, err error)
	SetServiceProperties(ctx context.Context, resourceGroupName string, accountName string, parameters storage.QueueServiceProperties) (result storage.QueueServiceProperties, err error)
}

QueueServicesClientAPI contains the set of methods on the QueueServicesClient type.

type SkusClientAPI

type SkusClientAPI interface {
	List(ctx context.Context) (result storage.SkuListResult, err error)
}

SkusClientAPI contains the set of methods on the SkusClient type.

type TableClientAPI

type TableClientAPI interface {
	Create(ctx context.Context, resourceGroupName string, accountName string, tableName string, parameters *storage.Table) (result storage.Table, err error)
	Delete(ctx context.Context, resourceGroupName string, accountName string, tableName string) (result autorest.Response, err error)
	Get(ctx context.Context, resourceGroupName string, accountName string, tableName string) (result storage.Table, err error)
	List(ctx context.Context, resourceGroupName string, accountName string) (result storage.ListTableResourcePage, err error)
	ListComplete(ctx context.Context, resourceGroupName string, accountName string) (result storage.ListTableResourceIterator, err error)
	Update(ctx context.Context, resourceGroupName string, accountName string, tableName string, parameters *storage.Table) (result storage.Table, err error)
}

TableClientAPI contains the set of methods on the TableClient type.

type TableServicesClientAPI

type TableServicesClientAPI interface {
	GetServiceProperties(ctx context.Context, resourceGroupName string, accountName string) (result storage.TableServiceProperties, err error)
	List(ctx context.Context, resourceGroupName string, accountName string) (result storage.ListTableServices, err error)
	SetServiceProperties(ctx context.Context, resourceGroupName string, accountName string, parameters storage.TableServiceProperties) (result storage.TableServiceProperties, err error)
}

TableServicesClientAPI contains the set of methods on the TableServicesClient type.

type UsagesClientAPI

type UsagesClientAPI interface {
	ListByLocation(ctx context.Context, location string) (result storage.UsageListResult, err error)
}

UsagesClientAPI contains the set of methods on the UsagesClient type.