backupengines

package
v0.20241023.1122425 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicesbackup/2024-02-01/backupengines Documentation

The backupengines SDK allows for interaction with Azure Resource Manager recoveryservicesbackup (API Version 2024-02-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/recoveryservicesbackup/2024-02-01/backupengines"

Client Initialization

client := backupengines.NewBackupEnginesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BackupEnginesClient.Get

ctx := context.TODO()
id := backupengines.NewBackupEngineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultName", "backupEngineName")

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

Example Usage: BackupEnginesClient.List

ctx := context.TODO()
id := backupengines.NewVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultName")

// alternatively `client.List(ctx, id, backupengines.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, backupengines.DefaultListOperationOptions())
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 PossibleValuesForBackupEngineType 

func PossibleValuesForBackupEngineType() []string

func PossibleValuesForBackupManagementType 

func PossibleValuesForBackupManagementType() []string

func ValidateBackupEngineID 

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

ValidateBackupEngineID checks that 'input' can be parsed as a Backup Engine ID

func ValidateVaultID 

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

ValidateVaultID checks that 'input' can be parsed as a Vault ID

Types

type AzureBackupServerEngine 

type AzureBackupServerEngine struct {
	AzureBackupAgentVersion            *string                   `json:"azureBackupAgentVersion,omitempty"`
	BackupEngineId                     *string                   `json:"backupEngineId,omitempty"`
	BackupEngineState                  *string                   `json:"backupEngineState,omitempty"`
	BackupEngineType                   BackupEngineType          `json:"backupEngineType"`
	BackupManagementType               *BackupManagementType     `json:"backupManagementType,omitempty"`
	CanReRegister                      *bool                     `json:"canReRegister,omitempty"`
	DpmVersion                         *string                   `json:"dpmVersion,omitempty"`
	ExtendedInfo                       *BackupEngineExtendedInfo `json:"extendedInfo,omitempty"`
	FriendlyName                       *string                   `json:"friendlyName,omitempty"`
	HealthStatus                       *string                   `json:"healthStatus,omitempty"`
	IsAzureBackupAgentUpgradeAvailable *bool                     `json:"isAzureBackupAgentUpgradeAvailable,omitempty"`
	IsDpmUpgradeAvailable              *bool                     `json:"isDpmUpgradeAvailable,omitempty"`
	RegistrationStatus                 *string                   `json:"registrationStatus,omitempty"`
}

func (AzureBackupServerEngine) BackupEngineBase added in v0.20240920.1135249 

func (s AzureBackupServerEngine) BackupEngineBase() BaseBackupEngineBaseImpl

func (AzureBackupServerEngine) MarshalJSON 

func (s AzureBackupServerEngine) MarshalJSON() ([]byte, error)

type BackupEngineBase 

type BackupEngineBase interface {
	BackupEngineBase() BaseBackupEngineBaseImpl
}

func UnmarshalBackupEngineBaseImplementation added in v0.20240920.1135249 

func UnmarshalBackupEngineBaseImplementation(input []byte) (BackupEngineBase, error)

type BackupEngineBaseResource 

type BackupEngineBaseResource struct {
	ETag       *string            `json:"eTag,omitempty"`
	Id         *string            `json:"id,omitempty"`
	Location   *string            `json:"location,omitempty"`
	Name       *string            `json:"name,omitempty"`
	Properties BackupEngineBase   `json:"properties"`
	Tags       *map[string]string `json:"tags,omitempty"`
	Type       *string            `json:"type,omitempty"`
}

func (*BackupEngineBaseResource) UnmarshalJSON 

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

type BackupEngineBaseResourceOperationPredicate 

type BackupEngineBaseResourceOperationPredicate struct {
	ETag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (BackupEngineBaseResourceOperationPredicate) Matches 

func (p BackupEngineBaseResourceOperationPredicate) Matches(input BackupEngineBaseResource) bool

type BackupEngineExtendedInfo 

type BackupEngineExtendedInfo struct {
	AvailableDiskSpace      *float64 `json:"availableDiskSpace,omitempty"`
	AzureProtectedInstances *int64   `json:"azureProtectedInstances,omitempty"`
	DatabaseName            *string  `json:"databaseName,omitempty"`
	DiskCount               *int64   `json:"diskCount,omitempty"`
	ProtectedItemsCount     *int64   `json:"protectedItemsCount,omitempty"`
	ProtectedServersCount   *int64   `json:"protectedServersCount,omitempty"`
	RefreshedAt             *string  `json:"refreshedAt,omitempty"`
	UsedDiskSpace           *float64 `json:"usedDiskSpace,omitempty"`
}

func (*BackupEngineExtendedInfo) GetRefreshedAtAsTime 

func (o *BackupEngineExtendedInfo) GetRefreshedAtAsTime() (*time.Time, error)

func (*BackupEngineExtendedInfo) SetRefreshedAtAsTime 

func (o *BackupEngineExtendedInfo) SetRefreshedAtAsTime(input time.Time)

type BackupEngineId 

type BackupEngineId struct {
	SubscriptionId    string
	ResourceGroupName string
	VaultName         string
	BackupEngineName  string
}

BackupEngineId is a struct representing the Resource ID for a Backup Engine

func NewBackupEngineID 

func NewBackupEngineID(subscriptionId string, resourceGroupName string, vaultName string, backupEngineName string) BackupEngineId

NewBackupEngineID returns a new BackupEngineId struct

func ParseBackupEngineID 

func ParseBackupEngineID(input string) (*BackupEngineId, error)

ParseBackupEngineID parses 'input' into a BackupEngineId

func ParseBackupEngineIDInsensitively 

func ParseBackupEngineIDInsensitively(input string) (*BackupEngineId, error)

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

func (*BackupEngineId) FromParseResult 

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

func (BackupEngineId) ID 

func (id BackupEngineId) ID() string

ID returns the formatted Backup Engine ID

func (BackupEngineId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Backup Engine ID

func (BackupEngineId) String 

func (id BackupEngineId) String() string

String returns a human-readable description of this Backup Engine ID

type BackupEngineType 

type BackupEngineType string
const (
	BackupEngineTypeAzureBackupServerEngine BackupEngineType = "AzureBackupServerEngine"
	BackupEngineTypeDpmBackupEngine         BackupEngineType = "DpmBackupEngine"
	BackupEngineTypeInvalid                 BackupEngineType = "Invalid"
)

type BackupEnginesClient 

type BackupEnginesClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewBackupEnginesClientWithBaseURI 

func NewBackupEnginesClientWithBaseURI(endpoint string) BackupEnginesClient

func (BackupEnginesClient) Get 

func (c BackupEnginesClient) Get(ctx context.Context, id BackupEngineId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (BackupEnginesClient) List 

func (c BackupEnginesClient) List(ctx context.Context, id VaultId, options ListOperationOptions) (resp ListOperationResponse, err error)

List ...

func (BackupEnginesClient) ListComplete 

func (c BackupEnginesClient) ListComplete(ctx context.Context, id VaultId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all of the results into a single object

func (BackupEnginesClient) ListCompleteMatchingPredicate 

func (c BackupEnginesClient) ListCompleteMatchingPredicate(ctx context.Context, id VaultId, options ListOperationOptions, predicate BackupEngineBaseResourceOperationPredicate) (resp ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type BackupManagementType 

type BackupManagementType string
const (
	BackupManagementTypeAzureBackupServer BackupManagementType = "AzureBackupServer"
	BackupManagementTypeAzureIaasVM       BackupManagementType = "AzureIaasVM"
	BackupManagementTypeAzureSql          BackupManagementType = "AzureSql"
	BackupManagementTypeAzureStorage      BackupManagementType = "AzureStorage"
	BackupManagementTypeAzureWorkload     BackupManagementType = "AzureWorkload"
	BackupManagementTypeDPM               BackupManagementType = "DPM"
	BackupManagementTypeDefaultBackup     BackupManagementType = "DefaultBackup"
	BackupManagementTypeInvalid           BackupManagementType = "Invalid"
	BackupManagementTypeMAB               BackupManagementType = "MAB"
)

type BaseBackupEngineBaseImpl added in v0.20240920.1135249 

type BaseBackupEngineBaseImpl struct {
	AzureBackupAgentVersion            *string                   `json:"azureBackupAgentVersion,omitempty"`
	BackupEngineId                     *string                   `json:"backupEngineId,omitempty"`
	BackupEngineState                  *string                   `json:"backupEngineState,omitempty"`
	BackupEngineType                   BackupEngineType          `json:"backupEngineType"`
	BackupManagementType               *BackupManagementType     `json:"backupManagementType,omitempty"`
	CanReRegister                      *bool                     `json:"canReRegister,omitempty"`
	DpmVersion                         *string                   `json:"dpmVersion,omitempty"`
	ExtendedInfo                       *BackupEngineExtendedInfo `json:"extendedInfo,omitempty"`
	FriendlyName                       *string                   `json:"friendlyName,omitempty"`
	HealthStatus                       *string                   `json:"healthStatus,omitempty"`
	IsAzureBackupAgentUpgradeAvailable *bool                     `json:"isAzureBackupAgentUpgradeAvailable,omitempty"`
	IsDpmUpgradeAvailable              *bool                     `json:"isDpmUpgradeAvailable,omitempty"`
	RegistrationStatus                 *string                   `json:"registrationStatus,omitempty"`
}

func (BaseBackupEngineBaseImpl) BackupEngineBase added in v0.20240920.1135249 

func (s BaseBackupEngineBaseImpl) BackupEngineBase() BaseBackupEngineBaseImpl

type DpmBackupEngine 

type DpmBackupEngine struct {
	AzureBackupAgentVersion            *string                   `json:"azureBackupAgentVersion,omitempty"`
	BackupEngineId                     *string                   `json:"backupEngineId,omitempty"`
	BackupEngineState                  *string                   `json:"backupEngineState,omitempty"`
	BackupEngineType                   BackupEngineType          `json:"backupEngineType"`
	BackupManagementType               *BackupManagementType     `json:"backupManagementType,omitempty"`
	CanReRegister                      *bool                     `json:"canReRegister,omitempty"`
	DpmVersion                         *string                   `json:"dpmVersion,omitempty"`
	ExtendedInfo                       *BackupEngineExtendedInfo `json:"extendedInfo,omitempty"`
	FriendlyName                       *string                   `json:"friendlyName,omitempty"`
	HealthStatus                       *string                   `json:"healthStatus,omitempty"`
	IsAzureBackupAgentUpgradeAvailable *bool                     `json:"isAzureBackupAgentUpgradeAvailable,omitempty"`
	IsDpmUpgradeAvailable              *bool                     `json:"isDpmUpgradeAvailable,omitempty"`
	RegistrationStatus                 *string                   `json:"registrationStatus,omitempty"`
}

func (DpmBackupEngine) BackupEngineBase added in v0.20240920.1135249 

func (s DpmBackupEngine) BackupEngineBase() BaseBackupEngineBaseImpl

func (DpmBackupEngine) MarshalJSON 

func (s DpmBackupEngine) MarshalJSON() ([]byte, error)

type GetOperationOptions 

type GetOperationOptions struct {
	Filter *string
}

func DefaultGetOperationOptions 

func DefaultGetOperationOptions() GetOperationOptions

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *BackupEngineBaseResource
}

type ListCompleteResult 

type ListCompleteResult struct {
	Items []BackupEngineBaseResource
}

type ListOperationOptions 

type ListOperationOptions struct {
	Filter *string
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]BackupEngineBaseResource
	// contains filtered or unexported fields
}

func (ListOperationResponse) HasMore 

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore 

func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)

type RawBackupEngineBaseImpl 

type RawBackupEngineBaseImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawBackupEngineBaseImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

func (RawBackupEngineBaseImpl) BackupEngineBase added in v0.20240920.1135249 

func (s RawBackupEngineBaseImpl) BackupEngineBase() BaseBackupEngineBaseImpl

type VaultId 

type VaultId struct {
	SubscriptionId    string
	ResourceGroupName string
	VaultName         string
}

VaultId is a struct representing the Resource ID for a Vault

func NewVaultID 

func NewVaultID(subscriptionId string, resourceGroupName string, vaultName string) VaultId

NewVaultID returns a new VaultId struct

func ParseVaultID 

func ParseVaultID(input string) (*VaultId, error)

ParseVaultID parses 'input' into a VaultId

func ParseVaultIDInsensitively 

func ParseVaultIDInsensitively(input string) (*VaultId, error)

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

func (*VaultId) FromParseResult 

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

func (VaultId) ID 

func (id VaultId) ID() string

ID returns the formatted Vault ID

func (VaultId) Segments 

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

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

func (VaultId) String 

func (id VaultId) String() string

String returns a human-readable description of this Vault ID

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.