deletedaccounts

README

github.com/hashicorp/go-azure-sdk/resource-manager/storage/2023-05-01/deletedaccounts Documentation

The deletedaccounts SDK allows for interaction with the Azure Resource Manager Service storage (API Version 2023-05-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/storage/2023-05-01/deletedaccounts"

Client Initialization

client := deletedaccounts.NewDeletedAccountsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DeletedAccountsClient.Get

ctx := context.TODO()
id := deletedaccounts.NewDeletedAccountID("12345678-1234-9876-4563-123456789012", "locationValue", "deletedAccountValue")

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: DeletedAccountsClient.List

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Documentation

Index

• func ValidateDeletedAccountID(input interface{}, key string) (warnings []string, errors []error)
• type DeletedAccount
• type DeletedAccountId
  • func NewDeletedAccountID(subscriptionId string, locationName string, deletedAccountName string) DeletedAccountId
  • func ParseDeletedAccountID(input string) (*DeletedAccountId, error)
  • func ParseDeletedAccountIDInsensitively(input string) (*DeletedAccountId, error)
  • func (id *DeletedAccountId) FromParseResult(input resourceids.ParseResult) error
  • func (id DeletedAccountId) ID() string
  • func (id DeletedAccountId) Segments() []resourceids.Segment
  • func (id DeletedAccountId) String() string
• type DeletedAccountOperationPredicate
  • func (p DeletedAccountOperationPredicate) Matches(input DeletedAccount) bool
• type DeletedAccountProperties
• type DeletedAccountsClient
  • func NewDeletedAccountsClientWithBaseURI(sdkApi sdkEnv.Api) (*DeletedAccountsClient, error)
  • func (c DeletedAccountsClient) Get(ctx context.Context, id DeletedAccountId) (result GetOperationResponse, err error)
  • func (c DeletedAccountsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
  • func (c DeletedAccountsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)
  • func (c DeletedAccountsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListCompleteResult, err error)
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationResponse

Functions

func ValidateDeletedAccountID

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

ValidateDeletedAccountID checks that 'input' can be parsed as a Deleted Account ID

Types

type DeletedAccount

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

type DeletedAccountId

type DeletedAccountId struct {
	SubscriptionId     string
	LocationName       string
	DeletedAccountName string
}

DeletedAccountId is a struct representing the Resource ID for a Deleted Account

func NewDeletedAccountID

func NewDeletedAccountID(subscriptionId string, locationName string, deletedAccountName string) DeletedAccountId

NewDeletedAccountID returns a new DeletedAccountId struct

func ParseDeletedAccountID

func ParseDeletedAccountID(input string) (*DeletedAccountId, error)

ParseDeletedAccountID parses 'input' into a DeletedAccountId

func ParseDeletedAccountIDInsensitively

func ParseDeletedAccountIDInsensitively(input string) (*DeletedAccountId, error)

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

func (*DeletedAccountId) FromParseResult

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

func (DeletedAccountId) ID

func (id DeletedAccountId) ID() string

ID returns the formatted Deleted Account ID

func (DeletedAccountId) Segments

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

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

func (DeletedAccountId) String

func (id DeletedAccountId) String() string

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

type DeletedAccountOperationPredicate

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

func (DeletedAccountOperationPredicate) Matches

func (p DeletedAccountOperationPredicate) Matches(input DeletedAccount) bool

type DeletedAccountProperties

type DeletedAccountProperties struct {
	CreationTime             *string `json:"creationTime,omitempty"`
	DeletionTime             *string `json:"deletionTime,omitempty"`
	Location                 *string `json:"location,omitempty"`
	RestoreReference         *string `json:"restoreReference,omitempty"`
	StorageAccountResourceId *string `json:"storageAccountResourceId,omitempty"`
}

type DeletedAccountsClient

type DeletedAccountsClient struct {
	Client *resourcemanager.Client
}

func NewDeletedAccountsClientWithBaseURI

func NewDeletedAccountsClientWithBaseURI(sdkApi sdkEnv.Api) (*DeletedAccountsClient, error)

func (DeletedAccountsClient) Get

func (c DeletedAccountsClient) Get(ctx context.Context, id DeletedAccountId) (result GetOperationResponse, err error)

Get ...

func (DeletedAccountsClient) List

func (c DeletedAccountsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (DeletedAccountsClient) ListComplete

func (c DeletedAccountsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (DeletedAccountsClient) ListCompleteMatchingPredicate

func (c DeletedAccountsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate DeletedAccountOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DeletedAccount
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DeletedAccount
}