backupprotectableitems

package
v0.20240708.1080555 Latest Latest
Warning

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

 Go to latest Published: Jul 8, 2024 License: MPL-2.0 Imports: 10 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicesbackup/2023-04-01/backupprotectableitems Documentation

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

Client Initialization

client := backupprotectableitems.NewBackupProtectableItemsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BackupProtectableItemsClient.List

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

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

func PossibleValuesForAzureFileShareType() []string

func PossibleValuesForInquiryStatus 

func PossibleValuesForInquiryStatus() []string

func PossibleValuesForProtectionStatus 

func PossibleValuesForProtectionStatus() []string

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 AzureFileShareProtectableItem 

type AzureFileShareProtectableItem struct {
	AzureFileShareType          *AzureFileShareType `json:"azureFileShareType,omitempty"`
	ParentContainerFabricId     *string             `json:"parentContainerFabricId,omitempty"`
	ParentContainerFriendlyName *string             `json:"parentContainerFriendlyName,omitempty"`

	// Fields inherited from WorkloadProtectableItem
	BackupManagementType *string           `json:"backupManagementType,omitempty"`
	FriendlyName         *string           `json:"friendlyName,omitempty"`
	ProtectionState      *ProtectionStatus `json:"protectionState,omitempty"`
	WorkloadType         *string           `json:"workloadType,omitempty"`
}

func (AzureFileShareProtectableItem) MarshalJSON 

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

type AzureFileShareType 

type AzureFileShareType string
const (
	AzureFileShareTypeInvalid AzureFileShareType = "Invalid"
	AzureFileShareTypeXSMB    AzureFileShareType = "XSMB"
	AzureFileShareTypeXSync   AzureFileShareType = "XSync"
)

type AzureIaaSClassicComputeVMProtectableItem 

type AzureIaaSClassicComputeVMProtectableItem struct {
	ResourceGroup         *string `json:"resourceGroup,omitempty"`
	VirtualMachineId      *string `json:"virtualMachineId,omitempty"`
	VirtualMachineVersion *string `json:"virtualMachineVersion,omitempty"`

	// Fields inherited from WorkloadProtectableItem
	BackupManagementType *string           `json:"backupManagementType,omitempty"`
	FriendlyName         *string           `json:"friendlyName,omitempty"`
	ProtectionState      *ProtectionStatus `json:"protectionState,omitempty"`
	WorkloadType         *string           `json:"workloadType,omitempty"`
}

func (AzureIaaSClassicComputeVMProtectableItem) MarshalJSON 

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

type AzureIaaSComputeVMProtectableItem 

type AzureIaaSComputeVMProtectableItem struct {
	ResourceGroup         *string `json:"resourceGroup,omitempty"`
	VirtualMachineId      *string `json:"virtualMachineId,omitempty"`
	VirtualMachineVersion *string `json:"virtualMachineVersion,omitempty"`

	// Fields inherited from WorkloadProtectableItem
	BackupManagementType *string           `json:"backupManagementType,omitempty"`
	FriendlyName         *string           `json:"friendlyName,omitempty"`
	ProtectionState      *ProtectionStatus `json:"protectionState,omitempty"`
	WorkloadType         *string           `json:"workloadType,omitempty"`
}

func (AzureIaaSComputeVMProtectableItem) MarshalJSON 

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

type AzureVMWorkloadProtectableItem 

type AzureVMWorkloadProtectableItem struct {
	IsAutoProtectable       *bool                `json:"isAutoProtectable,omitempty"`
	IsAutoProtected         *bool                `json:"isAutoProtected,omitempty"`
	IsProtectable           *bool                `json:"isProtectable,omitempty"`
	ParentName              *string              `json:"parentName,omitempty"`
	ParentUniqueName        *string              `json:"parentUniqueName,omitempty"`
	Prebackupvalidation     *PreBackupValidation `json:"prebackupvalidation,omitempty"`
	ServerName              *string              `json:"serverName,omitempty"`
	Subinquireditemcount    *int64               `json:"subinquireditemcount,omitempty"`
	Subprotectableitemcount *int64               `json:"subprotectableitemcount,omitempty"`

	// Fields inherited from WorkloadProtectableItem
	BackupManagementType *string           `json:"backupManagementType,omitempty"`
	FriendlyName         *string           `json:"friendlyName,omitempty"`
	ProtectionState      *ProtectionStatus `json:"protectionState,omitempty"`
	WorkloadType         *string           `json:"workloadType,omitempty"`
}

func (AzureVMWorkloadProtectableItem) MarshalJSON 

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

type AzureVMWorkloadSAPAseSystemProtectableItem 

type AzureVMWorkloadSAPAseSystemProtectableItem struct {
	IsAutoProtectable       *bool                `json:"isAutoProtectable,omitempty"`
	IsAutoProtected         *bool                `json:"isAutoProtected,omitempty"`
	IsProtectable           *bool                `json:"isProtectable,omitempty"`
	ParentName              *string              `json:"parentName,omitempty"`
	ParentUniqueName        *string              `json:"parentUniqueName,omitempty"`
	Prebackupvalidation     *PreBackupValidation `json:"prebackupvalidation,omitempty"`
	ServerName              *string              `json:"serverName,omitempty"`
	Subinquireditemcount    *int64               `json:"subinquireditemcount,omitempty"`
	Subprotectableitemcount *int64               `json:"subprotectableitemcount,omitempty"`

	// Fields inherited from WorkloadProtectableItem
	BackupManagementType *string           `json:"backupManagementType,omitempty"`
	FriendlyName         *string           `json:"friendlyName,omitempty"`
	ProtectionState      *ProtectionStatus `json:"protectionState,omitempty"`
	WorkloadType         *string           `json:"workloadType,omitempty"`
}

func (AzureVMWorkloadSAPAseSystemProtectableItem) MarshalJSON 

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

type AzureVMWorkloadSAPHanaDBInstance 

type AzureVMWorkloadSAPHanaDBInstance struct {
	IsAutoProtectable       *bool                `json:"isAutoProtectable,omitempty"`
	IsAutoProtected         *bool                `json:"isAutoProtected,omitempty"`
	IsProtectable           *bool                `json:"isProtectable,omitempty"`
	ParentName              *string              `json:"parentName,omitempty"`
	ParentUniqueName        *string              `json:"parentUniqueName,omitempty"`
	Prebackupvalidation     *PreBackupValidation `json:"prebackupvalidation,omitempty"`
	ServerName              *string              `json:"serverName,omitempty"`
	Subinquireditemcount    *int64               `json:"subinquireditemcount,omitempty"`
	Subprotectableitemcount *int64               `json:"subprotectableitemcount,omitempty"`

	// Fields inherited from WorkloadProtectableItem
	BackupManagementType *string           `json:"backupManagementType,omitempty"`
	FriendlyName         *string           `json:"friendlyName,omitempty"`
	ProtectionState      *ProtectionStatus `json:"protectionState,omitempty"`
	WorkloadType         *string           `json:"workloadType,omitempty"`
}

func (AzureVMWorkloadSAPHanaDBInstance) MarshalJSON 

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

type AzureVMWorkloadSAPHanaDatabaseProtectableItem 

type AzureVMWorkloadSAPHanaDatabaseProtectableItem struct {
	IsAutoProtectable       *bool                `json:"isAutoProtectable,omitempty"`
	IsAutoProtected         *bool                `json:"isAutoProtected,omitempty"`
	IsProtectable           *bool                `json:"isProtectable,omitempty"`
	ParentName              *string              `json:"parentName,omitempty"`
	ParentUniqueName        *string              `json:"parentUniqueName,omitempty"`
	Prebackupvalidation     *PreBackupValidation `json:"prebackupvalidation,omitempty"`
	ServerName              *string              `json:"serverName,omitempty"`
	Subinquireditemcount    *int64               `json:"subinquireditemcount,omitempty"`
	Subprotectableitemcount *int64               `json:"subprotectableitemcount,omitempty"`

	// Fields inherited from WorkloadProtectableItem
	BackupManagementType *string           `json:"backupManagementType,omitempty"`
	FriendlyName         *string           `json:"friendlyName,omitempty"`
	ProtectionState      *ProtectionStatus `json:"protectionState,omitempty"`
	WorkloadType         *string           `json:"workloadType,omitempty"`
}

func (AzureVMWorkloadSAPHanaDatabaseProtectableItem) MarshalJSON 

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

type AzureVMWorkloadSAPHanaHSRProtectableItem 

type AzureVMWorkloadSAPHanaHSRProtectableItem struct {
	IsAutoProtectable       *bool                `json:"isAutoProtectable,omitempty"`
	IsAutoProtected         *bool                `json:"isAutoProtected,omitempty"`
	IsProtectable           *bool                `json:"isProtectable,omitempty"`
	ParentName              *string              `json:"parentName,omitempty"`
	ParentUniqueName        *string              `json:"parentUniqueName,omitempty"`
	Prebackupvalidation     *PreBackupValidation `json:"prebackupvalidation,omitempty"`
	ServerName              *string              `json:"serverName,omitempty"`
	Subinquireditemcount    *int64               `json:"subinquireditemcount,omitempty"`
	Subprotectableitemcount *int64               `json:"subprotectableitemcount,omitempty"`

	// Fields inherited from WorkloadProtectableItem
	BackupManagementType *string           `json:"backupManagementType,omitempty"`
	FriendlyName         *string           `json:"friendlyName,omitempty"`
	ProtectionState      *ProtectionStatus `json:"protectionState,omitempty"`
	WorkloadType         *string           `json:"workloadType,omitempty"`
}

func (AzureVMWorkloadSAPHanaHSRProtectableItem) MarshalJSON 

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

type AzureVMWorkloadSAPHanaSystemProtectableItem 

type AzureVMWorkloadSAPHanaSystemProtectableItem struct {
	IsAutoProtectable       *bool                `json:"isAutoProtectable,omitempty"`
	IsAutoProtected         *bool                `json:"isAutoProtected,omitempty"`
	IsProtectable           *bool                `json:"isProtectable,omitempty"`
	ParentName              *string              `json:"parentName,omitempty"`
	ParentUniqueName        *string              `json:"parentUniqueName,omitempty"`
	Prebackupvalidation     *PreBackupValidation `json:"prebackupvalidation,omitempty"`
	ServerName              *string              `json:"serverName,omitempty"`
	Subinquireditemcount    *int64               `json:"subinquireditemcount,omitempty"`
	Subprotectableitemcount *int64               `json:"subprotectableitemcount,omitempty"`

	// Fields inherited from WorkloadProtectableItem
	BackupManagementType *string           `json:"backupManagementType,omitempty"`
	FriendlyName         *string           `json:"friendlyName,omitempty"`
	ProtectionState      *ProtectionStatus `json:"protectionState,omitempty"`
	WorkloadType         *string           `json:"workloadType,omitempty"`
}

func (AzureVMWorkloadSAPHanaSystemProtectableItem) MarshalJSON 

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

type AzureVMWorkloadSQLAvailabilityGroupProtectableItem 

type AzureVMWorkloadSQLAvailabilityGroupProtectableItem struct {
	IsAutoProtectable       *bool                   `json:"isAutoProtectable,omitempty"`
	IsAutoProtected         *bool                   `json:"isAutoProtected,omitempty"`
	IsProtectable           *bool                   `json:"isProtectable,omitempty"`
	NodesList               *[]DistributedNodesInfo `json:"nodesList,omitempty"`
	ParentName              *string                 `json:"parentName,omitempty"`
	ParentUniqueName        *string                 `json:"parentUniqueName,omitempty"`
	Prebackupvalidation     *PreBackupValidation    `json:"prebackupvalidation,omitempty"`
	ServerName              *string                 `json:"serverName,omitempty"`
	Subinquireditemcount    *int64                  `json:"subinquireditemcount,omitempty"`
	Subprotectableitemcount *int64                  `json:"subprotectableitemcount,omitempty"`

	// Fields inherited from WorkloadProtectableItem
	BackupManagementType *string           `json:"backupManagementType,omitempty"`
	FriendlyName         *string           `json:"friendlyName,omitempty"`
	ProtectionState      *ProtectionStatus `json:"protectionState,omitempty"`
	WorkloadType         *string           `json:"workloadType,omitempty"`
}

func (AzureVMWorkloadSQLAvailabilityGroupProtectableItem) MarshalJSON 

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

type AzureVMWorkloadSQLDatabaseProtectableItem 

type AzureVMWorkloadSQLDatabaseProtectableItem struct {
	IsAutoProtectable       *bool                `json:"isAutoProtectable,omitempty"`
	IsAutoProtected         *bool                `json:"isAutoProtected,omitempty"`
	IsProtectable           *bool                `json:"isProtectable,omitempty"`
	ParentName              *string              `json:"parentName,omitempty"`
	ParentUniqueName        *string              `json:"parentUniqueName,omitempty"`
	Prebackupvalidation     *PreBackupValidation `json:"prebackupvalidation,omitempty"`
	ServerName              *string              `json:"serverName,omitempty"`
	Subinquireditemcount    *int64               `json:"subinquireditemcount,omitempty"`
	Subprotectableitemcount *int64               `json:"subprotectableitemcount,omitempty"`

	// Fields inherited from WorkloadProtectableItem
	BackupManagementType *string           `json:"backupManagementType,omitempty"`
	FriendlyName         *string           `json:"friendlyName,omitempty"`
	ProtectionState      *ProtectionStatus `json:"protectionState,omitempty"`
	WorkloadType         *string           `json:"workloadType,omitempty"`
}

func (AzureVMWorkloadSQLDatabaseProtectableItem) MarshalJSON 

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

type AzureVMWorkloadSQLInstanceProtectableItem 

type AzureVMWorkloadSQLInstanceProtectableItem struct {
	IsAutoProtectable       *bool                `json:"isAutoProtectable,omitempty"`
	IsAutoProtected         *bool                `json:"isAutoProtected,omitempty"`
	IsProtectable           *bool                `json:"isProtectable,omitempty"`
	ParentName              *string              `json:"parentName,omitempty"`
	ParentUniqueName        *string              `json:"parentUniqueName,omitempty"`
	Prebackupvalidation     *PreBackupValidation `json:"prebackupvalidation,omitempty"`
	ServerName              *string              `json:"serverName,omitempty"`
	Subinquireditemcount    *int64               `json:"subinquireditemcount,omitempty"`
	Subprotectableitemcount *int64               `json:"subprotectableitemcount,omitempty"`

	// Fields inherited from WorkloadProtectableItem
	BackupManagementType *string           `json:"backupManagementType,omitempty"`
	FriendlyName         *string           `json:"friendlyName,omitempty"`
	ProtectionState      *ProtectionStatus `json:"protectionState,omitempty"`
	WorkloadType         *string           `json:"workloadType,omitempty"`
}

func (AzureVMWorkloadSQLInstanceProtectableItem) MarshalJSON 

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

type BackupProtectableItemsClient 

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

func NewBackupProtectableItemsClientWithBaseURI 

func NewBackupProtectableItemsClientWithBaseURI(endpoint string) BackupProtectableItemsClient

func (BackupProtectableItemsClient) List 

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

List ...

func (BackupProtectableItemsClient) ListComplete 

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

ListComplete retrieves all of the results into a single object

func (BackupProtectableItemsClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type DistributedNodesInfo 

type DistributedNodesInfo struct {
	ErrorDetail      *ErrorDetail `json:"errorDetail,omitempty"`
	NodeName         *string      `json:"nodeName,omitempty"`
	SourceResourceId *string      `json:"sourceResourceId,omitempty"`
	Status           *string      `json:"status,omitempty"`
}

type ErrorDetail 

type ErrorDetail struct {
	Code            *string   `json:"code,omitempty"`
	Message         *string   `json:"message,omitempty"`
	Recommendations *[]string `json:"recommendations,omitempty"`
}

type IaaSVMProtectableItem 

type IaaSVMProtectableItem struct {
	ResourceGroup         *string `json:"resourceGroup,omitempty"`
	VirtualMachineId      *string `json:"virtualMachineId,omitempty"`
	VirtualMachineVersion *string `json:"virtualMachineVersion,omitempty"`

	// Fields inherited from WorkloadProtectableItem
	BackupManagementType *string           `json:"backupManagementType,omitempty"`
	FriendlyName         *string           `json:"friendlyName,omitempty"`
	ProtectionState      *ProtectionStatus `json:"protectionState,omitempty"`
	WorkloadType         *string           `json:"workloadType,omitempty"`
}

func (IaaSVMProtectableItem) MarshalJSON 

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

type InquiryStatus 

type InquiryStatus string
const (
	InquiryStatusFailed  InquiryStatus = "Failed"
	InquiryStatusInvalid InquiryStatus = "Invalid"
	InquiryStatusSuccess InquiryStatus = "Success"
)

type ListCompleteResult 

type ListCompleteResult struct {
	Items []WorkloadProtectableItemResource
}

type ListOperationOptions 

type ListOperationOptions struct {
	Filter *string
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]WorkloadProtectableItemResource
	// 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 PreBackupValidation 

type PreBackupValidation struct {
	Code    *string        `json:"code,omitempty"`
	Message *string        `json:"message,omitempty"`
	Status  *InquiryStatus `json:"status,omitempty"`
}

type ProtectionStatus 

type ProtectionStatus string
const (
	ProtectionStatusInvalid          ProtectionStatus = "Invalid"
	ProtectionStatusNotProtected     ProtectionStatus = "NotProtected"
	ProtectionStatusProtected        ProtectionStatus = "Protected"
	ProtectionStatusProtecting       ProtectionStatus = "Protecting"
	ProtectionStatusProtectionFailed ProtectionStatus = "ProtectionFailed"
)

type RawWorkloadProtectableItemImpl 

type RawWorkloadProtectableItemImpl struct {
	Type   string
	Values map[string]interface{}
}

RawWorkloadProtectableItemImpl 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).

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

type WorkloadProtectableItem 

type WorkloadProtectableItem interface {
}

type WorkloadProtectableItemResource 

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

func (*WorkloadProtectableItemResource) UnmarshalJSON 

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

type WorkloadProtectableItemResourceOperationPredicate 

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

func (WorkloadProtectableItemResourceOperationPredicate) Matches 

func (p WorkloadProtectableItemResourceOperationPredicate) Matches(input WorkloadProtectableItemResource) bool

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.