protectablecontainers

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicesbackup/2022-03-01/protectablecontainers Documentation

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

Client Initialization

client := protectablecontainers.NewProtectableContainersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ProtectableContainersClient.List

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

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

Documentation

Index

• func PossibleValuesForBackupManagementType() []string
• func PossibleValuesForContainerType() []string
• func ValidateBackupFabricID(input interface{}, key string) (warnings []string, errors []error)
• type AzureStorageProtectableContainer
  • func (s AzureStorageProtectableContainer) MarshalJSON() ([]byte, error)
• type AzureVMAppContainerProtectableContainer
  • func (s AzureVMAppContainerProtectableContainer) MarshalJSON() ([]byte, error)
• type BackupFabricId
  • func NewBackupFabricID(subscriptionId string, resourceGroupName string, vaultName string, ...) BackupFabricId
  • func ParseBackupFabricID(input string) (*BackupFabricId, error)
  • func ParseBackupFabricIDInsensitively(input string) (*BackupFabricId, error)
  • func (id BackupFabricId) ID() string
  • func (id BackupFabricId) Segments() []resourceids.Segment
  • func (id BackupFabricId) String() string
• type BackupManagementType
• type ContainerType
• type ListCompleteResult
• type ListOperationOptions
  • func DefaultListOperationOptions() ListOperationOptions
• type ListOperationResponse
  • func (r ListOperationResponse) HasMore() bool
  • func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)
• type ProtectableContainer
• type ProtectableContainerResource
  • func (s *ProtectableContainerResource) UnmarshalJSON(bytes []byte) error
• type ProtectableContainerResourceOperationPredicate
  • func (p ProtectableContainerResourceOperationPredicate) Matches(input ProtectableContainerResource) bool
• type ProtectableContainersClient
  • func NewProtectableContainersClientWithBaseURI(endpoint string) ProtectableContainersClient
  • func (c ProtectableContainersClient) List(ctx context.Context, id BackupFabricId, options ListOperationOptions) (resp ListOperationResponse, err error)
  • func (c ProtectableContainersClient) ListComplete(ctx context.Context, id BackupFabricId, options ListOperationOptions) (ListCompleteResult, error)
  • func (c ProtectableContainersClient) ListCompleteMatchingPredicate(ctx context.Context, id BackupFabricId, options ListOperationOptions, ...) (resp ListCompleteResult, err error)

Functions

func PossibleValuesForBackupManagementType

func PossibleValuesForBackupManagementType() []string

func PossibleValuesForContainerType

func PossibleValuesForContainerType() []string

func ValidateBackupFabricID

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

ValidateBackupFabricID checks that 'input' can be parsed as a Backup Fabric ID

Types

type AzureStorageProtectableContainer

type AzureStorageProtectableContainer struct {

	// Fields inherited from ProtectableContainer
	BackupManagementType *BackupManagementType `json:"backupManagementType,omitempty"`
	ContainerId          *string               `json:"containerId,omitempty"`
	FriendlyName         *string               `json:"friendlyName,omitempty"`
	HealthStatus         *string               `json:"healthStatus,omitempty"`
}

func (AzureStorageProtectableContainer) MarshalJSON

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

type AzureVMAppContainerProtectableContainer

type AzureVMAppContainerProtectableContainer struct {

	// Fields inherited from ProtectableContainer
	BackupManagementType *BackupManagementType `json:"backupManagementType,omitempty"`
	ContainerId          *string               `json:"containerId,omitempty"`
	FriendlyName         *string               `json:"friendlyName,omitempty"`
	HealthStatus         *string               `json:"healthStatus,omitempty"`
}

func (AzureVMAppContainerProtectableContainer) MarshalJSON

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

type BackupFabricId

type BackupFabricId struct {
	SubscriptionId    string
	ResourceGroupName string
	VaultName         string
	BackupFabricName  string
}

BackupFabricId is a struct representing the Resource ID for a Backup Fabric

func NewBackupFabricID

func NewBackupFabricID(subscriptionId string, resourceGroupName string, vaultName string, backupFabricName string) BackupFabricId

NewBackupFabricID returns a new BackupFabricId struct

func ParseBackupFabricID

func ParseBackupFabricID(input string) (*BackupFabricId, error)

ParseBackupFabricID parses 'input' into a BackupFabricId

func ParseBackupFabricIDInsensitively

func ParseBackupFabricIDInsensitively(input string) (*BackupFabricId, error)

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

func (BackupFabricId) ID

func (id BackupFabricId) ID() string

ID returns the formatted Backup Fabric ID

func (BackupFabricId) Segments

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

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

func (BackupFabricId) String

func (id BackupFabricId) String() string

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

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 ContainerType

type ContainerType string

const (
	ContainerTypeAzureBackupServerContainer                  ContainerType = "AzureBackupServerContainer"
	ContainerTypeAzureSqlContainer                           ContainerType = "AzureSqlContainer"
	ContainerTypeAzureWorkloadContainer                      ContainerType = "AzureWorkloadContainer"
	ContainerTypeCluster                                     ContainerType = "Cluster"
	ContainerTypeDPMContainer                                ContainerType = "DPMContainer"
	ContainerTypeGenericContainer                            ContainerType = "GenericContainer"
	ContainerTypeIaasVMContainer                             ContainerType = "IaasVMContainer"
	ContainerTypeIaasVMServiceContainer                      ContainerType = "IaasVMServiceContainer"
	ContainerTypeInvalid                                     ContainerType = "Invalid"
	ContainerTypeMABContainer                                ContainerType = "MABContainer"
	ContainerTypeMicrosoftPointClassicComputeVirtualMachines ContainerType = "Microsoft.ClassicCompute/virtualMachines"
	ContainerTypeMicrosoftPointComputeVirtualMachines        ContainerType = "Microsoft.Compute/virtualMachines"
	ContainerTypeSQLAGWorkLoadContainer                      ContainerType = "SQLAGWorkLoadContainer"
	ContainerTypeStorageContainer                            ContainerType = "StorageContainer"
	ContainerTypeUnknown                                     ContainerType = "Unknown"
	ContainerTypeVCenter                                     ContainerType = "VCenter"
	ContainerTypeVMAppContainer                              ContainerType = "VMAppContainer"
	ContainerTypeWindows                                     ContainerType = "Windows"
)

type ListCompleteResult

type ListCompleteResult struct {
	Items []ProtectableContainerResource
}

type ListOperationOptions

type ListOperationOptions struct {
	Filter *string
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

type ListOperationResponse

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

type ProtectableContainer interface {
}

type ProtectableContainerResource

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

func (*ProtectableContainerResource) UnmarshalJSON

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

type ProtectableContainerResourceOperationPredicate

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

func (ProtectableContainerResourceOperationPredicate) Matches

func (p ProtectableContainerResourceOperationPredicate) Matches(input ProtectableContainerResource) bool

type ProtectableContainersClient

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

func NewProtectableContainersClientWithBaseURI

func NewProtectableContainersClientWithBaseURI(endpoint string) ProtectableContainersClient

func (ProtectableContainersClient) List

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

List ...

func (ProtectableContainersClient) ListComplete

func (c ProtectableContainersClient) ListComplete(ctx context.Context, id BackupFabricId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all of the results into a single object

func (ProtectableContainersClient) ListCompleteMatchingPredicate

func (c ProtectableContainersClient) ListCompleteMatchingPredicate(ctx context.Context, id BackupFabricId, options ListOperationOptions, predicate ProtectableContainerResourceOperationPredicate) (resp ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate