storageaccountcredentials

package
v0.20240903.1131440 Latest Latest
Warning

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

 Go to latest Published: Sep 3, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/databoxedge/2023-12-01/storageaccountcredentials Documentation

The storageaccountcredentials SDK allows for interaction with the Azure Resource Manager Service databoxedge (API Version 2023-12-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/databoxedge/2023-12-01/storageaccountcredentials"

Client Initialization

client := storageaccountcredentials.NewStorageAccountCredentialsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: StorageAccountCredentialsClient.CreateOrUpdate

ctx := context.TODO()
id := storageaccountcredentials.NewStorageAccountCredentialID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceValue", "storageAccountCredentialValue")

payload := storageaccountcredentials.StorageAccountCredential{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: StorageAccountCredentialsClient.Delete

ctx := context.TODO()
id := storageaccountcredentials.NewStorageAccountCredentialID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceValue", "storageAccountCredentialValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: StorageAccountCredentialsClient.Get

ctx := context.TODO()
id := storageaccountcredentials.NewStorageAccountCredentialID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceValue", "storageAccountCredentialValue")

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: StorageAccountCredentialsClient.ListByDataBoxEdgeDevice

ctx := context.TODO()
id := storageaccountcredentials.NewDataBoxEdgeDeviceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAccountType 

func PossibleValuesForAccountType() []string

func PossibleValuesForEncryptionAlgorithm 

func PossibleValuesForEncryptionAlgorithm() []string

func PossibleValuesForSSLStatus 

func PossibleValuesForSSLStatus() []string

func ValidateDataBoxEdgeDeviceID 

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

ValidateDataBoxEdgeDeviceID checks that 'input' can be parsed as a Data Box Edge Device ID

func ValidateStorageAccountCredentialID 

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

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

Types

type AccountType 

type AccountType string
const (
	AccountTypeBlobStorage           AccountType = "BlobStorage"
	AccountTypeGeneralPurposeStorage AccountType = "GeneralPurposeStorage"
)

func (*AccountType) UnmarshalJSON 

func (s *AccountType) UnmarshalJSON(bytes []byte) error

type AsymmetricEncryptedSecret 

type AsymmetricEncryptedSecret struct {
	EncryptionAlgorithm      EncryptionAlgorithm `json:"encryptionAlgorithm"`
	EncryptionCertThumbprint *string             `json:"encryptionCertThumbprint,omitempty"`
	Value                    string              `json:"value"`
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StorageAccountCredential
}

type DataBoxEdgeDeviceId 

type DataBoxEdgeDeviceId struct {
	SubscriptionId        string
	ResourceGroupName     string
	DataBoxEdgeDeviceName string
}

DataBoxEdgeDeviceId is a struct representing the Resource ID for a Data Box Edge Device

func NewDataBoxEdgeDeviceID 

func NewDataBoxEdgeDeviceID(subscriptionId string, resourceGroupName string, dataBoxEdgeDeviceName string) DataBoxEdgeDeviceId

NewDataBoxEdgeDeviceID returns a new DataBoxEdgeDeviceId struct

func ParseDataBoxEdgeDeviceID 

func ParseDataBoxEdgeDeviceID(input string) (*DataBoxEdgeDeviceId, error)

ParseDataBoxEdgeDeviceID parses 'input' into a DataBoxEdgeDeviceId

func ParseDataBoxEdgeDeviceIDInsensitively 

func ParseDataBoxEdgeDeviceIDInsensitively(input string) (*DataBoxEdgeDeviceId, error)

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

func (*DataBoxEdgeDeviceId) FromParseResult 

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

func (DataBoxEdgeDeviceId) ID 

func (id DataBoxEdgeDeviceId) ID() string

ID returns the formatted Data Box Edge Device ID

func (DataBoxEdgeDeviceId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Data Box Edge Device ID

func (DataBoxEdgeDeviceId) String 

func (id DataBoxEdgeDeviceId) String() string

String returns a human-readable description of this Data Box Edge Device ID

type DeleteOperationResponse 

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

type EncryptionAlgorithm 

type EncryptionAlgorithm string
const (
	EncryptionAlgorithmAESTwoFiveSix        EncryptionAlgorithm = "AES256"
	EncryptionAlgorithmNone                 EncryptionAlgorithm = "None"
	EncryptionAlgorithmRSAESPKCSOneVOneFive EncryptionAlgorithm = "RSAES_PKCS1_v_1_5"
)

func (*EncryptionAlgorithm) UnmarshalJSON 

func (s *EncryptionAlgorithm) UnmarshalJSON(bytes []byte) error

type GetOperationResponse 

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

type ListByDataBoxEdgeDeviceCompleteResult 

type ListByDataBoxEdgeDeviceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []StorageAccountCredential
}

type ListByDataBoxEdgeDeviceCustomPager added in v0.20240628.1153531 

type ListByDataBoxEdgeDeviceCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByDataBoxEdgeDeviceCustomPager) NextPageLink() *odata.Link

type ListByDataBoxEdgeDeviceOperationResponse 

type ListByDataBoxEdgeDeviceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]StorageAccountCredential
}

type SSLStatus 

type SSLStatus string
const (
	SSLStatusDisabled SSLStatus = "Disabled"
	SSLStatusEnabled  SSLStatus = "Enabled"
)

func (*SSLStatus) UnmarshalJSON 

func (s *SSLStatus) UnmarshalJSON(bytes []byte) error

type StorageAccountCredential 

type StorageAccountCredential struct {
	Id         *string                            `json:"id,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties StorageAccountCredentialProperties `json:"properties"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type StorageAccountCredentialId 

type StorageAccountCredentialId struct {
	SubscriptionId               string
	ResourceGroupName            string
	DataBoxEdgeDeviceName        string
	StorageAccountCredentialName string
}

StorageAccountCredentialId is a struct representing the Resource ID for a Storage Account Credential

func NewStorageAccountCredentialID 

func NewStorageAccountCredentialID(subscriptionId string, resourceGroupName string, dataBoxEdgeDeviceName string, storageAccountCredentialName string) StorageAccountCredentialId

NewStorageAccountCredentialID returns a new StorageAccountCredentialId struct

func ParseStorageAccountCredentialID 

func ParseStorageAccountCredentialID(input string) (*StorageAccountCredentialId, error)

ParseStorageAccountCredentialID parses 'input' into a StorageAccountCredentialId

func ParseStorageAccountCredentialIDInsensitively 

func ParseStorageAccountCredentialIDInsensitively(input string) (*StorageAccountCredentialId, error)

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

func (*StorageAccountCredentialId) FromParseResult 

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

func (StorageAccountCredentialId) ID 

func (id StorageAccountCredentialId) ID() string

ID returns the formatted Storage Account Credential ID

func (StorageAccountCredentialId) Segments 

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

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

func (StorageAccountCredentialId) String 

func (id StorageAccountCredentialId) String() string

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

type StorageAccountCredentialOperationPredicate 

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

func (StorageAccountCredentialOperationPredicate) Matches 

func (p StorageAccountCredentialOperationPredicate) Matches(input StorageAccountCredential) bool

type StorageAccountCredentialProperties 

type StorageAccountCredentialProperties struct {
	AccountKey       *AsymmetricEncryptedSecret `json:"accountKey,omitempty"`
	AccountType      AccountType                `json:"accountType"`
	Alias            string                     `json:"alias"`
	BlobDomainName   *string                    `json:"blobDomainName,omitempty"`
	ConnectionString *string                    `json:"connectionString,omitempty"`
	SslStatus        SSLStatus                  `json:"sslStatus"`
	StorageAccountId *string                    `json:"storageAccountId,omitempty"`
	UserName         *string                    `json:"userName,omitempty"`
}

type StorageAccountCredentialsClient 

type StorageAccountCredentialsClient struct {
	Client *resourcemanager.Client
}

func NewStorageAccountCredentialsClientWithBaseURI 

func NewStorageAccountCredentialsClientWithBaseURI(sdkApi sdkEnv.Api) (*StorageAccountCredentialsClient, error)

func (StorageAccountCredentialsClient) CreateOrUpdate 

func (c StorageAccountCredentialsClient) CreateOrUpdate(ctx context.Context, id StorageAccountCredentialId, input StorageAccountCredential) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (StorageAccountCredentialsClient) CreateOrUpdateThenPoll 

func (c StorageAccountCredentialsClient) CreateOrUpdateThenPoll(ctx context.Context, id StorageAccountCredentialId, input StorageAccountCredential) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (StorageAccountCredentialsClient) Delete 

func (c StorageAccountCredentialsClient) Delete(ctx context.Context, id StorageAccountCredentialId) (result DeleteOperationResponse, err error)

Delete ...

func (StorageAccountCredentialsClient) DeleteThenPoll 

func (c StorageAccountCredentialsClient) DeleteThenPoll(ctx context.Context, id StorageAccountCredentialId) error

DeleteThenPoll performs Delete then polls until it's completed

func (StorageAccountCredentialsClient) Get 

func (c StorageAccountCredentialsClient) Get(ctx context.Context, id StorageAccountCredentialId) (result GetOperationResponse, err error)

Get ...

func (StorageAccountCredentialsClient) ListByDataBoxEdgeDevice 

func (c StorageAccountCredentialsClient) ListByDataBoxEdgeDevice(ctx context.Context, id DataBoxEdgeDeviceId) (result ListByDataBoxEdgeDeviceOperationResponse, err error)

ListByDataBoxEdgeDevice ...

func (StorageAccountCredentialsClient) ListByDataBoxEdgeDeviceComplete 

func (c StorageAccountCredentialsClient) ListByDataBoxEdgeDeviceComplete(ctx context.Context, id DataBoxEdgeDeviceId) (ListByDataBoxEdgeDeviceCompleteResult, error)

ListByDataBoxEdgeDeviceComplete retrieves all the results into a single object

func (StorageAccountCredentialsClient) ListByDataBoxEdgeDeviceCompleteMatchingPredicate 

func (c StorageAccountCredentialsClient) ListByDataBoxEdgeDeviceCompleteMatchingPredicate(ctx context.Context, id DataBoxEdgeDeviceId, predicate StorageAccountCredentialOperationPredicate) (result ListByDataBoxEdgeDeviceCompleteResult, err error)

ListByDataBoxEdgeDeviceCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.