storageaccounts

package
v0.20240118.1113719 Latest Latest
Warning

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

 Go to latest Published: Jan 18, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/datalakeanalytics/2016-11-01/storageaccounts Documentation

The storageaccounts SDK allows for interaction with the Azure Resource Manager Service datalakeanalytics (API Version 2016-11-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/datalakeanalytics/2016-11-01/storageaccounts"

Client Initialization

client := storageaccounts.NewStorageAccountsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: StorageAccountsClient.Add

ctx := context.TODO()
id := storageaccounts.NewStorageAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "storageAccountValue")

payload := storageaccounts.AddStorageAccountParameters{
	// ...
}


read, err := client.Add(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: StorageAccountsClient.Delete

ctx := context.TODO()
id := storageaccounts.NewStorageAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "storageAccountValue")

read, err := client.Delete(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: StorageAccountsClient.Get

ctx := context.TODO()
id := storageaccounts.NewStorageAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "storageAccountValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: StorageAccountsClient.GetStorageContainer

ctx := context.TODO()
id := storageaccounts.NewContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "storageAccountValue", "containerValue")

read, err := client.GetStorageContainer(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: StorageAccountsClient.ListByAccount

ctx := context.TODO()
id := storageaccounts.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")

// alternatively `client.ListByAccount(ctx, id, storageaccounts.DefaultListByAccountOperationOptions())` can be used to do batched pagination
items, err := client.ListByAccountComplete(ctx, id, storageaccounts.DefaultListByAccountOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: StorageAccountsClient.ListSasTokens

ctx := context.TODO()
id := storageaccounts.NewContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "storageAccountValue", "containerValue")

// alternatively `client.ListSasTokens(ctx, id)` can be used to do batched pagination
items, err := client.ListSasTokensComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: StorageAccountsClient.ListStorageContainers

ctx := context.TODO()
id := storageaccounts.NewStorageAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "storageAccountValue")

// alternatively `client.ListStorageContainers(ctx, id)` can be used to do batched pagination
items, err := client.ListStorageContainersComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: StorageAccountsClient.Update

ctx := context.TODO()
id := storageaccounts.NewStorageAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "storageAccountValue")

payload := storageaccounts.UpdateStorageAccountParameters{
	// ...
}


read, err := client.Update(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateAccountID 

func ValidateAccountID(input interface{}, key string) (warnings []string, errors []error)

ValidateAccountID checks that 'input' can be parsed as a Account ID

func ValidateContainerID 

func ValidateContainerID(input interface{}, key string) (warnings []string, errors []error)

ValidateContainerID checks that 'input' can be parsed as a Container ID

func ValidateStorageAccountID 

func ValidateStorageAccountID(input interface{}, key string) (warnings []string, errors []error)

ValidateStorageAccountID checks that 'input' can be parsed as a Storage Account ID

Types

type AccountId 

type AccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
}

AccountId is a struct representing the Resource ID for a Account

func NewAccountID 

func NewAccountID(subscriptionId string, resourceGroupName string, accountName string) AccountId

NewAccountID returns a new AccountId struct

func ParseAccountID 

func ParseAccountID(input string) (*AccountId, error)

ParseAccountID parses 'input' into a AccountId

func ParseAccountIDInsensitively 

func ParseAccountIDInsensitively(input string) (*AccountId, error)

ParseAccountIDInsensitively parses 'input' case-insensitively into a AccountId note: this method should only be used for API response data and not user input

func (*AccountId) FromParseResult added in v0.20231127.1171502 

func (id *AccountId) FromParseResult(input resourceids.ParseResult) error

func (AccountId) ID 

func (id AccountId) ID() string

ID returns the formatted Account ID

func (AccountId) Segments 

func (id AccountId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Account ID

func (AccountId) String 

func (id AccountId) String() string

String returns a human-readable description of this Account ID

type AddOperationResponse 

type AddOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type AddStorageAccountParameters 

type AddStorageAccountParameters struct {
	Properties AddStorageAccountProperties `json:"properties"`
}

type AddStorageAccountProperties 

type AddStorageAccountProperties struct {
	AccessKey string  `json:"accessKey"`
	Suffix    *string `json:"suffix,omitempty"`
}

type ContainerId 

type ContainerId struct {
	SubscriptionId     string
	ResourceGroupName  string
	AccountName        string
	StorageAccountName string
	ContainerName      string
}

ContainerId is a struct representing the Resource ID for a Container

func NewContainerID 

func NewContainerID(subscriptionId string, resourceGroupName string, accountName string, storageAccountName string, containerName string) ContainerId

NewContainerID returns a new ContainerId struct

func ParseContainerID 

func ParseContainerID(input string) (*ContainerId, error)

ParseContainerID parses 'input' into a ContainerId

func ParseContainerIDInsensitively 

func ParseContainerIDInsensitively(input string) (*ContainerId, error)

ParseContainerIDInsensitively parses 'input' case-insensitively into a ContainerId note: this method should only be used for API response data and not user input

func (*ContainerId) FromParseResult added in v0.20231127.1171502 

func (id *ContainerId) FromParseResult(input resourceids.ParseResult) error

func (ContainerId) ID 

func (id ContainerId) ID() string

ID returns the formatted Container ID

func (ContainerId) Segments 

func (id ContainerId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Container ID

func (ContainerId) String 

func (id ContainerId) String() string

String returns a human-readable description of this Container ID

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StorageAccountInformation
}

type GetStorageContainerOperationResponse 

type GetStorageContainerOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StorageContainer
}

type ListByAccountCompleteResult 

type ListByAccountCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []StorageAccountInformation
}

type ListByAccountOperationOptions 

type ListByAccountOperationOptions struct {
	Count   *bool
	Filter  *string
	Orderby *string
	Select  *string
	Skip    *int64
	Top     *int64
}

func DefaultListByAccountOperationOptions 

func DefaultListByAccountOperationOptions() ListByAccountOperationOptions

func (ListByAccountOperationOptions) ToHeaders added in v0.20230516.1215417 

func (o ListByAccountOperationOptions) ToHeaders() *client.Headers

func (ListByAccountOperationOptions) ToOData added in v0.20230516.1215417 

func (o ListByAccountOperationOptions) ToOData() *odata.Query

func (ListByAccountOperationOptions) ToQuery added in v0.20230516.1215417 

func (o ListByAccountOperationOptions) ToQuery() *client.QueryParams

type ListByAccountOperationResponse 

type ListByAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]StorageAccountInformation
}

type ListSasTokensCompleteResult 

type ListSasTokensCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SasTokenInformation
}

type ListSasTokensOperationResponse 

type ListSasTokensOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SasTokenInformation
}

type ListStorageContainersCompleteResult 

type ListStorageContainersCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []StorageContainer
}

type ListStorageContainersOperationResponse 

type ListStorageContainersOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]StorageContainer
}

type SasTokenInformation 

type SasTokenInformation struct {
	AccessToken *string `json:"accessToken,omitempty"`
}

type SasTokenInformationOperationPredicate 

type SasTokenInformationOperationPredicate struct {
	AccessToken *string
}

func (SasTokenInformationOperationPredicate) Matches 

func (p SasTokenInformationOperationPredicate) Matches(input SasTokenInformation) bool

type StorageAccountId 

type StorageAccountId struct {
	SubscriptionId     string
	ResourceGroupName  string
	AccountName        string
	StorageAccountName string
}

StorageAccountId is a struct representing the Resource ID for a Storage Account

func NewStorageAccountID 

func NewStorageAccountID(subscriptionId string, resourceGroupName string, accountName string, storageAccountName string) StorageAccountId

NewStorageAccountID returns a new StorageAccountId struct

func ParseStorageAccountID 

func ParseStorageAccountID(input string) (*StorageAccountId, error)

ParseStorageAccountID parses 'input' into a StorageAccountId

func ParseStorageAccountIDInsensitively 

func ParseStorageAccountIDInsensitively(input string) (*StorageAccountId, error)

ParseStorageAccountIDInsensitively parses 'input' case-insensitively into a StorageAccountId note: this method should only be used for API response data and not user input

func (*StorageAccountId) FromParseResult added in v0.20231127.1171502 

func (id *StorageAccountId) FromParseResult(input resourceids.ParseResult) error

func (StorageAccountId) ID 

func (id StorageAccountId) ID() string

ID returns the formatted Storage Account ID

func (StorageAccountId) Segments 

func (id StorageAccountId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Storage Account ID

func (StorageAccountId) String 

func (id StorageAccountId) String() string

String returns a human-readable description of this Storage Account ID

type StorageAccountInformation 

type StorageAccountInformation struct {
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *StorageAccountInformationProperties `json:"properties,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type StorageAccountInformationOperationPredicate 

type StorageAccountInformationOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (StorageAccountInformationOperationPredicate) Matches 

func (p StorageAccountInformationOperationPredicate) Matches(input StorageAccountInformation) bool

type StorageAccountInformationProperties 

type StorageAccountInformationProperties struct {
	Suffix *string `json:"suffix,omitempty"`
}

type StorageAccountsClient 

type StorageAccountsClient struct {
	Client *resourcemanager.Client
}

func NewStorageAccountsClientWithBaseURI 

func NewStorageAccountsClientWithBaseURI(sdkApi sdkEnv.Api) (*StorageAccountsClient, error)

func (StorageAccountsClient) Add 

func (c StorageAccountsClient) Add(ctx context.Context, id StorageAccountId, input AddStorageAccountParameters) (result AddOperationResponse, err error)

Add ...

func (StorageAccountsClient) Delete 

func (c StorageAccountsClient) Delete(ctx context.Context, id StorageAccountId) (result DeleteOperationResponse, err error)

Delete ...

func (StorageAccountsClient) Get 

func (c StorageAccountsClient) Get(ctx context.Context, id StorageAccountId) (result GetOperationResponse, err error)

Get ...

func (StorageAccountsClient) GetStorageContainer 

func (c StorageAccountsClient) GetStorageContainer(ctx context.Context, id ContainerId) (result GetStorageContainerOperationResponse, err error)

GetStorageContainer ...

func (StorageAccountsClient) ListByAccount 

func (c StorageAccountsClient) ListByAccount(ctx context.Context, id AccountId, options ListByAccountOperationOptions) (result ListByAccountOperationResponse, err error)

ListByAccount ...

func (StorageAccountsClient) ListByAccountComplete 

func (c StorageAccountsClient) ListByAccountComplete(ctx context.Context, id AccountId, options ListByAccountOperationOptions) (ListByAccountCompleteResult, error)

ListByAccountComplete retrieves all the results into a single object

func (StorageAccountsClient) ListByAccountCompleteMatchingPredicate 

func (c StorageAccountsClient) ListByAccountCompleteMatchingPredicate(ctx context.Context, id AccountId, options ListByAccountOperationOptions, predicate StorageAccountInformationOperationPredicate) (result ListByAccountCompleteResult, err error)

ListByAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (StorageAccountsClient) ListSasTokens 

func (c StorageAccountsClient) ListSasTokens(ctx context.Context, id ContainerId) (result ListSasTokensOperationResponse, err error)

ListSasTokens ...

func (StorageAccountsClient) ListSasTokensComplete 

func (c StorageAccountsClient) ListSasTokensComplete(ctx context.Context, id ContainerId) (ListSasTokensCompleteResult, error)

ListSasTokensComplete retrieves all the results into a single object

func (StorageAccountsClient) ListSasTokensCompleteMatchingPredicate 

func (c StorageAccountsClient) ListSasTokensCompleteMatchingPredicate(ctx context.Context, id ContainerId, predicate SasTokenInformationOperationPredicate) (result ListSasTokensCompleteResult, err error)

ListSasTokensCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (StorageAccountsClient) ListStorageContainers 

func (c StorageAccountsClient) ListStorageContainers(ctx context.Context, id StorageAccountId) (result ListStorageContainersOperationResponse, err error)

ListStorageContainers ...

func (StorageAccountsClient) ListStorageContainersComplete 

func (c StorageAccountsClient) ListStorageContainersComplete(ctx context.Context, id StorageAccountId) (ListStorageContainersCompleteResult, error)

ListStorageContainersComplete retrieves all the results into a single object

func (StorageAccountsClient) ListStorageContainersCompleteMatchingPredicate 

func (c StorageAccountsClient) ListStorageContainersCompleteMatchingPredicate(ctx context.Context, id StorageAccountId, predicate StorageContainerOperationPredicate) (result ListStorageContainersCompleteResult, err error)

ListStorageContainersCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (StorageAccountsClient) Update 

func (c StorageAccountsClient) Update(ctx context.Context, id StorageAccountId, input UpdateStorageAccountParameters) (result UpdateOperationResponse, err error)

Update ...

type StorageContainer 

type StorageContainer struct {
	Id         *string                     `json:"id,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *StorageContainerProperties `json:"properties,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type StorageContainerOperationPredicate 

type StorageContainerOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (StorageContainerOperationPredicate) Matches 

func (p StorageContainerOperationPredicate) Matches(input StorageContainer) bool

type StorageContainerProperties 

type StorageContainerProperties struct {
	LastModifiedTime *string `json:"lastModifiedTime,omitempty"`
}

func (*StorageContainerProperties) GetLastModifiedTimeAsTime 

func (o *StorageContainerProperties) GetLastModifiedTimeAsTime() (*time.Time, error)

func (*StorageContainerProperties) SetLastModifiedTimeAsTime 

func (o *StorageContainerProperties) SetLastModifiedTimeAsTime(input time.Time)

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type UpdateStorageAccountParameters 

type UpdateStorageAccountParameters struct {
	Properties *UpdateStorageAccountProperties `json:"properties,omitempty"`
}

type UpdateStorageAccountProperties 

type UpdateStorageAccountProperties struct {
	AccessKey *string `json:"accessKey,omitempty"`
	Suffix    *string `json:"suffix,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

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